This is my checklist since there's so many things to do - maybe useful for others but its specifically for people deploying 'official' adafruit libraries

  1. Create Adafruit_CircuitPython_sensor in
  2. Go to git repo settings, manage access, add CircuitPython Librarians team, then set to Write
  3. Fork to @ladyada
  4. git clone to M4 board and to personal library folder
  5. cd to the personal library directory in MSYS2, run cookiecutter gh:adafruit/cookiecutter-adafruit-circuitpython
  1. Move everything from the new directory up one to git repo
  2. Remove

Open up and fix capitalization of first naming after license

Add short description for first .. todo::

Add URL or remove second todo

Remove third todo, uncomment deps

Like so!

  • Open up requirements.txt - verify Adafruit-Blinka is there, possibly adafruit-circuitpython-busdevice. For UART devices, add pyserial
  • Open up README.rst and update the description .. todo::
  • Open up docs/index.rst and remove the todo's
  • Do first commit & PR
  • Write code!
  • Add example to examples/ empty file
  • Run pylint on and examples/
  • Once those pass, do another commit
  • Put example in README.rst like so:

This guide was first published on Jul 31, 2017. It was last updated on Feb 13, 2024.

This page (Ladyada's Checklist) was last updated on Sep 09, 2018.

Text editor powered by tinymce.