Contributing
If you'd like to contribute to the CircuitPython project, the CircuitPython libraries are a great way to begin. This page is updated with daily status information from the CircuitPython libraries, including open pull requests, open issues and library infrastructure issues.
Do you write a language other than English? Another great way to contribute to the project is to contribute new localizations (translations) of CircuitPython, or update current localizations, using Weblate.
If this is your first time contributing, or you'd like to see our recommended contribution workflow, we have a guide on Contributing to CircuitPython with Git and Github. You can also find us in the #circuitpython channel on the Adafruit Discord.
Have an idea for a new driver or library? File an issue on the CircuitPython repo!
Current Status for Tue, May 30, 2023
Library Infrastructure Issues
The following are issues with the library infrastructure. Having a standard library structure greatly improves overall maintainability. Accordingly, we have a series of checks to ensure the standard is met. Most of these are changes that can be made via a pull request, however there are a few checks reported here that require changes to GitHub settings. If you are interested in addressing any of these issues, please feel free to contact us with any questions.
If you're looking for a Good First Issue to begin contributing, consider the two issues related to
example naming: "Example file(s) missing sensor/library name." and "Missing simpletest example."
Every repo should have a libraryname_simpletest.py file in the examples folder at a
minimum. Any other included examples should be prefixed with libraryname_ so all
examples found in any given repo folder start with the library name followed by an underscore.
The GitHub end of things is a simple fix, however, please be aware many examples are linked in
Learn guides. You should mention in your pull request that it is possible that guides will
require updating to match the new example name.
-
CircuitPython drivers page missing driver
- https://github.com/adafruit/Adafruit_CircuitPython_MachXO
- https://github.com/adafruit/Adafruit_CircuitPython_ULP_Blink
- https://github.com/adafruit/Adafruit_CircuitPython_JTAG
- https://github.com/adafruit/Adafruit_CircuitPython_Debug_Probe
- https://github.com/adafruit/Adafruit_CircuitPython_MCU_Flasher
- https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_FlipClock
- https://github.com/adafruit/Adafruit_CircuitPython_Register_SPI
- https://github.com/adafruit/Adafruit_CircuitPython_BLE_Creation
- https://github.com/adafruit/Adafruit_CircuitPython_LSM6DS
- https://github.com/adafruit/Adafruit_CircuitPython_Typing
- https://github.com/adafruit/Adafruit_CircuitPython_JSON_Stream
- https://github.com/adafruit/Adafruit_CircuitPython_Prompt_Toolkit
-
Example file(s) missing sensor/library name
- https://github.com/adafruit/Adafruit_CircuitPython_MachXO
- https://github.com/adafruit/Adafruit_CircuitPython_MCU_Flasher
- https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_FlipClock
- https://github.com/adafruit/Adafruit_CircuitPython_MSA301
- https://github.com/adafruit/Adafruit_CircuitPython_LTR329_LTR303
- https://github.com/adafruit/Adafruit_CircuitPython_GUVX_I2C
- https://github.com/adafruit/Adafruit_CircuitPython_TCA9548A
- https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_Layout
- https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI
- https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT
- https://github.com/adafruit/Adafruit_CircuitPython_asyncio
- https://github.com/adafruit/Adafruit_CircuitPython_EPD
- https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx
-
Failed CI build
- https://github.com/adafruit/Adafruit_CircuitPython_MFRC630
- https://github.com/adafruit/Adafruit_CircuitPython_AT86RF233
- https://github.com/adafruit/Adafruit_CircuitPython_Debug_Bus_Device
- https://github.com/adafruit/Adafruit_CircuitPython_Debug_SPI
- https://github.com/adafruit/Adafruit_CircuitPython_Debug_Probe
- https://github.com/adafruit/Adafruit_CircuitPython_MCU_Flasher
- https://github.com/adafruit/Adafruit_CircuitPython_Wiznet5k
- Failed to load RTD build status (RTD error)
- For pypi compatibility, missing Adafruit-Blinka in requirements.txt
- For PyPI compatibility, missing optional_requirements.txt
- For PyPI compatibility, missing pyproject.toml
- For PyPI compatibility, missing requirements.txt
- Library has new commits since last release over a month ago
-
Library has new commits since last release within the last month
- https://github.com/adafruit/Adafruit_CircuitPython_MCP3xxx (19 days)
- https://github.com/adafruit/Adafruit_CircuitPython_RGBLED (19 days)
- https://github.com/adafruit/Adafruit_CircuitPython_Pastebin (19 days)
- https://github.com/adafruit/Adafruit_CircuitPython_Touchscreen (30 days)
- https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT (25 days)
- https://github.com/adafruit/Adafruit_CircuitPython_MIDI (13 days)
- https://github.com/adafruit/Adafruit_CircuitPython_MacroPad (28 days)
- https://github.com/adafruit/Adafruit_CircuitPython_seesaw (10 days)
- https://github.com/adafruit/Adafruit_CircuitPython_BNO055 (19 days)
- https://github.com/adafruit/Adafruit_CircuitPython_PCA9685 (27 days)
- Library has new commits since last release within the last week
-
Library repository has no releases
- https://github.com/adafruit/Adafruit_CircuitPython_MachXO
- https://github.com/adafruit/Adafruit_CircuitPython_ULP_Blink
- https://github.com/adafruit/Adafruit_CircuitPython_JTAG
- https://github.com/adafruit/Adafruit_CircuitPython_Debug_Probe
- https://github.com/adafruit/Adafruit_CircuitPython_MCU_Flasher
- https://github.com/adafruit/Adafruit_CircuitPython_MatrixKeypad
- https://github.com/adafruit/Adafruit_CircuitPython_Register_SPI
- https://github.com/adafruit/Adafruit_CircuitPython_wave
- https://github.com/adafruit/Adafruit_CircuitPython_JSON_Stream
- https://github.com/adafruit/Adafruit_CircuitPython_Prompt_Toolkit
- Library uses setup.py, needs to be converted to pyproject.toml
- Mismatched readthedocs.yaml
-
Mismatched versions in .pre-commit-config.yaml
- https://github.com/adafruit/Adafruit_CircuitPython_MachXO
- https://github.com/adafruit/Adafruit_CircuitPython_JTAG
- https://github.com/adafruit/Adafruit_CircuitPython_RSA
- https://github.com/adafruit/Adafruit_CircuitPython_PCF8574
- https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_FlipClock
- https://github.com/adafruit/Adafruit_CircuitPython_MCP2515
- https://github.com/adafruit/Adafruit_CircuitPython_JSON_Stream
- https://github.com/adafruit/Adafruit_CircuitPython_FeatherWing
- Missing .pre-commit-config.yaml
- Missing CODE_OF_CONDUCT.md
- Missing examples folder
- Missing license.
- Missing lint config
- Missing README.rst
- Missing readthedocs.yaml
- Missing repository description
-
New repo(s) currently in work, and unreleased
- https://github.com/adafruit/Adafruit_CircuitPython_PyCamera
- https://github.com/adafruit/Adafruit_CircuitPython_MFRC630
- https://github.com/adafruit/Adafruit_CircuitPython_AT86RF233
- https://github.com/adafruit/Adafruit_CircuitPython_Debug_Bus_Device
- https://github.com/adafruit/Adafruit_CircuitPython_Debug_SPI
- https://github.com/adafruit/Adafruit_CircuitPython_RTD266X_Prog
-
Not in bundle.
- https://github.com/adafruit/Adafruit_CircuitPython_MachXO
- https://github.com/adafruit/Adafruit_CircuitPython_ULP_Blink
- https://github.com/adafruit/Adafruit_CircuitPython_JTAG
- https://github.com/adafruit/Adafruit_CircuitPython_Debug_Probe
- https://github.com/adafruit/Adafruit_CircuitPython_MCU_Flasher
- https://github.com/adafruit/Adafruit_CircuitPython_Register_SPI
- https://github.com/adafruit/Adafruit_CircuitPython_TestRepo
- https://github.com/adafruit/Adafruit_CircuitPython_BLE_Creation
- https://github.com/adafruit/Adafruit_CircuitPython_Typing
- https://github.com/adafruit/Adafruit_CircuitPython_JSON_Stream
- https://github.com/adafruit/Adafruit_CircuitPython_Prompt_Toolkit
-
Not listed on PyPi for CPython use
- https://github.com/adafruit/Adafruit_CircuitPython_MachXO
- https://github.com/adafruit/Adafruit_CircuitPython_ULP_Blink
- https://github.com/adafruit/Adafruit_CircuitPython_JTAG
- https://github.com/adafruit/Adafruit_CircuitPython_Debug_Probe
- https://github.com/adafruit/Adafruit_CircuitPython_MCU_Flasher
- https://github.com/adafruit/Adafruit_CircuitPython_Register_SPI
- https://github.com/adafruit/Adafruit_CircuitPython_JSON_Stream
- https://github.com/adafruit/Adafruit_CircuitPython_Prompt_Toolkit
-
Only allow merges, disallow rebase and squash
- https://github.com/adafruit/Adafruit_CircuitPython_PyCamera
- https://github.com/adafruit/Adafruit_CircuitPython_RTD266X_Prog
- https://github.com/adafruit/Adafruit_CircuitPython_ULP_Blink
- https://github.com/adafruit/Adafruit_CircuitPython_Debug_Probe
- https://github.com/adafruit/Adafruit_CircuitPython_MCU_Flasher
- https://github.com/adafruit/Adafruit_CircuitPython_NeoPxl8
- https://github.com/adafruit/Adafruit_CircuitPython_wave
-
ReadTheDocs missing as a subproject on CircuitPython
- https://github.com/adafruit/Adafruit_CircuitPython_MachXO
- https://github.com/adafruit/Adafruit_CircuitPython_ULP_Blink
- https://github.com/adafruit/Adafruit_CircuitPython_JTAG
- https://github.com/adafruit/Adafruit_CircuitPython_Debug_Probe
- https://github.com/adafruit/Adafruit_CircuitPython_MCU_Flasher
- https://github.com/adafruit/Adafruit_CircuitPython_BLE_Beacon
- https://github.com/adafruit/Adafruit_CircuitPython_Register_SPI
- https://github.com/adafruit/Adafruit_CircuitPython_Pastebin
- https://github.com/adafruit/Adafruit_CircuitPython_JSON_Stream
- https://github.com/adafruit/Adafruit_CircuitPython_Prompt_Toolkit
- Unable to pull repo contents
-
Wiki should be disabled
- https://github.com/adafruit/Adafruit_CircuitPython_PyCamera
- https://github.com/adafruit/Adafruit_CircuitPython_RTD266X_Prog
- https://github.com/adafruit/Adafruit_CircuitPython_ULP_Blink
- https://github.com/adafruit/Adafruit_CircuitPython_Debug_Probe
- https://github.com/adafruit/Adafruit_CircuitPython_MCU_Flasher
- https://github.com/adafruit/Adafruit_CircuitPython_NeoPxl8
- https://github.com/adafruit/Adafruit_CircuitPython_Wii_Classic
- https://github.com/adafruit/Adafruit_CircuitPython_wave