circuitpython-org/contributing.html
2023-06-23 10:03:47 +00:00

771 lines
23 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-7723544-8"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-7723544-8');
</script>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" href="/assets/images/favicon.ico" type="image/x-icon" />
<meta name="msapplication-TileColor" content="#1a1919">
<meta name="msapplication-TileImage" content="https://cdn-shop.adafruit.com/static/mstile-144x144.png" />
<title>Contributing - Pull Requests</title>
<meta name="description" content="The easiest way to program microcontrollers" />
<!-- Twitter and Open Graph cards -->
<meta name="twitter:site" content="@circuitpython" />
<meta property="og:url" content="https://circuitpython.org/contributing" />
<meta property="og:title" content="CircuitPython - Contributing - Pull Requests" />
<meta property="og:description" content="The easiest way to program microcontrollers" />
<meta name="twitter:card" content="summary" />
<meta property="og:image" content="https://circuitpython.org/assets/images/CircuitPythonLogo_Black.png" />
<meta property="og:type" content="website" />
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.5.0/css/all.css" integrity="sha384-B4dIYHKNBt8Bc12p+WXckhzcICo0wtJAoU8YZTY5qE0Id1GSseTk6S+L3BlXeVIU" crossorigin="anonymous">
<link rel="stylesheet" href="/assets/css/main.css">
<link rel="canonical" href="https://circuitpython.org/contributing">
<!-- CircuitPython RSS Feed -->
<link rel="alternate"
type="application/rss+xml"
title="CircuitPython news!"
href="https://blog.adafruit.com/category/circuitpython/feed/"/>
<link rel="alternate" type="application/rss+xml" title="Latest Boards" href="/feed.rss"/>
<script src="/assets/javascript/header_mobile.js"></script>
</head>
<body>
<header id="site-header">
<nav class="top-navigation">
<div>
<div class="navigation">
<a class="skip-link" href="#main-content">Skip to main content</a>
<a class='active' href="/contributing">Contributing</a>
<a href="https://blog.adafruit.com/category/circuitpython">News</a>
<a href="/awesome">Awesome</a>
<a href="https://www.adafruitdaily.com/category/circuitpython">Newsletter</a>
<a href="https://docs.circuitpython.org/">Documentation</a>
<a href="https://forums.adafruit.com/viewforum.php?f=60">Forums</a>
<a href="https://adafru.it/discord" aria-label="Discord"><i class="fab fa-discord"></i> Discord</a>
<a href="/feed.rss" type="application/rss+xml" aria-label="RSS Feed"><i class="fas fa-rss-square"></i> RSS</a>
</div>
</div>
</nav>
<div class="wrapper">
<div class="content">
<nav class="site-brand">
<div class="site-logo">
<a href="/">
<img src="/assets/images/logo.png"
srcset="/assets/images/logo.png 1x,
/assets/images/logo@2x.png 2x,
/assets/images/logo@3x.png 3x"
alt="CircuitPython Logo"
height="60" width="136">
</a>
</div>
<div class="site-navigation">
<a href="/downloads">Downloads</a>
<a href="/libraries">Libraries</a>
<a href="/blinka">Blinka</a>
</div>
<div class="get-started">
<a href="https://learn.adafruit.com/welcome-to-circuitpython">Get Started</a>
</div>
</nav>
</div>
</div>
<div class="bottom-bar"></div>
</header>
<header id="mobile-header">
<div class="header-contents">
<div class="site-logo">
<a href="/">
<img src="/assets/images/logo.png"
srcset="/assets/images/logo.png 1x,
/assets/images/logo@2x.png 2x,
/assets/images/logo@3x.png 3x"
alt="CircuitPython Logo"
height="60" width="136">
</a>
</div>
<div id="mobile-menu">
<div class="menu-toggle">
<a href="#" id="mobile-menu-button">
<span class="sr-only">Open Mobile Menu</span>
<i class="fa fa-bars" aria-hidden="true"></i>
</a>
</div>
</div>
<div class="clear"></div>
<nav id="mobile-menu-contents" role="navigation" class="hidden"
aria-expanded="false" aria-label="Mobile Menu">
<ul>
<li><a
href="/downloads">Downloads</a></li>
<li><a
href="/libraries">Libraries</a></li>
<li><a
href="/blinka">Blinka</a></li>
<li><a class='active'
href="/contributing">Contributing</a></li>
<li><a href="https://blog.adafruit.com/category/circuitpython">News</a></li>
<li><a
href="/awesome">Awesome</a></li>
<li><a href="https://www.adafruitdaily.com/category/circuitpython">Newsletter</a></li>
<li><a href="https://learn.adafruit.com/welcome-to-circuitpython">Get Started</a></li>
<li><a href="https://forums.adafruit.com/viewforum.php?f=60">Forums</a></li>
<li><a href="https://adafru.it/discord" aria-label="Discord"><i class="fab fa-discord"></i> Discord</a></li>
</ul>
</nav>
</div>
<div class="bottom-bar"></div>
</header>
<div id="main-content" class="wrapper">
<div id="common-page" class="common-layout">
<div class="content">
<!-- https://github.com/adafruit/circuitpython/issues/1246 -->
<div id="contributing-page">
<h1>Contributing</h1>
<p>
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.
</p>
<p>
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
<a href="https://hosted.weblate.org/engage/circuitpython/">Weblate</a>.
</p>
<p>
If this is your first time contributing, or you'd
like to see our recommended contribution workflow, we have a guide on
<a href="https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github">Contributing to CircuitPython with Git and Github</a>.
You can also find us in the #circuitpython channel on the
<a href="https://adafru.it/discord">Adafruit Discord</a>.
</p>
<p>
Have an idea for a new driver or library?
<a href="https://github.com/adafruit/circuitpython/issues">File an issue on the CircuitPython repo!</a>
</p>
<h2>Current Status for Thu, Jun 22, 2023</h2>
<ul class='tabbed-navigation'>
<li>
<a href="/contributing" class='active'>Pull Requests</a>
</li>
<li>
<a href="/contributing/open-issues" >Open Issues</a>
</li>
<li>
<a href="/contributing/library-infrastructure-issues" >Library Infrastructure Issues</a>
</li>
<li>
<a href="/contributing/weblate" >CircuitPython Localization</a>
</li>
</ul>
<div class="clear"></div>
<p>
This is the current status of open pull requests and issues across all of the library repos.
</p>
<div class="libraries open-pull-requests">
<h3>Open Pull Requests</h3>
<ul>
<li>
Adafruit_CircuitPython_AdafruitIO
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO/pull/98">Add TypeHints to adafruit_io.py (Open 58 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_ADT7410
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_ADT7410/pull/24">updating lib (Open 9 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_AS7341
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_AS7341/pull/34">using _all_channels to update efficiently (Open 77 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_asyncio
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_asyncio/pull/31">Fix canceling of a gather operation (Open 247 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_AVRprog
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_AVRprog/pull/34">Type annotations and suspected minor bug fix (Open 57 days)</a></li>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_AVRprog/pull/32">First pass at adding type annotations (Open 247 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_BME680
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_BME680/pull/64">Add method to disable gas heater (Open 3 days)</a></li>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_BME680/pull/62">feedback from pr61 (Open 9 days)</a></li>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_BME680/pull/56">Use correct value to compute gas resistance (Open 189 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_Display_Button
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_Display_Button/pull/37">Adding annotations (Open 57 days)</a></li>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_Display_Button/pull/36">adding sprite_button and refactoring to package instead of single file (Open 424 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_DisplayIO_SSD1306
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306/pull/33">Example using Pico & Picowbell with I2C temp sensor (Open 22 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_DS3231
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_DS3231/pull/47">Fix path to product image. (Open 62 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_EMC2101
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_EMC2101/pull/29">Add Missing Type Annotations - Partial (Open 71 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_EPD
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_EPD/pull/62">Acep 7color (Open 70 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_ESP32SPI
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI/pull/168">Examples and tests for debugging (Open 388 days)</a></li>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI/pull/167">Compatible socket (Open 389 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_ESP_ATcontrol
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_ESP_ATcontrol/pull/65">Changes to support WPA Enterprise mode (Open 240 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_Fingerprint
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_Fingerprint/pull/51">Example with image rendering functionality (Open 65 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_FRAM
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_FRAM/pull/34">allow setting FRAM size (Open 296 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_GPS
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_GPS/pull/102">fix minute parsing (Open 22 days)</a></li>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_GPS/pull/99">Fix format specifier (Open 30 days)</a></li>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_GPS/pull/94">Added decoding of 'PGTOP' to get the status of the antenna extension … (Open 173 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_HT16K33
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_HT16K33/pull/114">implement non_blocking_marquee (Open 37 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_HTTPServer
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_HTTPServer/pull/58">Server headers, FormData, some docs improvements and fix for bug in ChunkedResponse (Open 12 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_LED_Animation
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation/pull/67">Timed animation (Open 996 days)</a></li>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation/pull/66">Volume animation (Open 996 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_Logging
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_Logging/pull/51">Use timestamp (Open 8 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_LSM303_Accel
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_LSM303_Accel/pull/14">Adds FIFO Buffer capabilities (Open 303 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_MAX1704x
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_MAX1704x/pull/6">pretty sure this should not be +1 (Open 306 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_MCP2515
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_MCP2515/pull/20">Make full use of all hardware acceptance masks and filters (Open 50 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_MCP9808
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_MCP9808/pull/37">fixing_example (Open 3 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_MIDI
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_MIDI/pull/52">added typehints to midimessage and init (Open 57 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_MiniMQTT
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT/pull/169">loop() timeout parameter should be absolute (Open 7 days)</a></li>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT/pull/168">recv_into fix for esp32spi socket implementation (Open 36 days)</a></li>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT/pull/162">Settings dot toml (Open 57 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_MLX90640
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_MLX90640/pull/32">Added commented out board.STEMMA_I2C with explanation (Open 215 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_MS8607
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_MS8607/pull/13">Added type annotations. (Open 30 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_NeoKey
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_NeoKey/pull/11">Read all 4 buttons with one call. (Open 4 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_Nunchuk
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_Nunchuk/pull/31">Added commented out board.STEMMA_I2C with explanation (Open 215 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_PCA9685
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_PCA9685/pull/55">Update import and initializations to current standards (Open 30 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_PCF8523
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_PCF8523/pull/30">timer-support (Open 144 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_PIOASM
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_PIOASM/pull/51">Run mypy during pre-commit to verify typing information (Open 276 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_Requests
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_Requests/pull/135">remove backwards compatibility (Open 11 days)</a></li>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_Requests/pull/118">Simple async http requests (Open 237 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_RFM69
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_RFM69/pull/45">Breaking change: Add configurable bitrates, asyncio support, and expose interrupt handler when platform supports (Open 22 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_RGBLED
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_RGBLED/pull/25">Error check colors (Open 90 days)</a></li>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_RGBLED/pull/23">Add typing (Open 94 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_SCD4X
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_SCD4X/pull/7">Add one shot co2 measurement (Open 663 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_ServoKit
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_ServoKit/pull/49">Fix i2c parameter documentation (Open 30 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_TinyLoRa
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_TinyLoRa/pull/50">lint: add almost all annotations to pass `mypy --strict` (Open 58 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_turtle
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_turtle/pull/35">adding type annotations for adafruit_turtle.py (Open 55 days)</a></li>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_turtle/pull/34">Fix koch examples (Open 63 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_VEML6070
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_VEML6070/pull/24">Added commented out board.STEMMA_I2C with explanation (Open 215 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_VL53L4CD
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_VL53L4CD/pull/9">Measurement quality (Open 63 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_Wiznet5k
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_Wiznet5k/pull/123">Remove ntp client (Open 0 days)</a></li>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_Wiznet5k/pull/122">Fix DHCP socket leak (Open 1 days)</a></li>
</ul>
</li>
<li>
Adafruit_CircuitPython_WSGI
<ul>
<li><a href="https://github.com/adafruit/Adafruit_CircuitPython_WSGI/pull/20">Move esp32spi_wsgi server code to here (Open 2 days)</a></li>
</ul>
</li>
<li>
cookiecutter-adafruit-circuitpython
<ul>
<li><a href="https://github.com/adafruit/cookiecutter-adafruit-circuitpython/pull/224">feat(pre-commit): add isort (Open 56 days)</a></li>
<li><a href="https://github.com/adafruit/cookiecutter-adafruit-circuitpython/pull/197">Mpy size actions (Open 308 days)</a></li>
</ul>
</li>
</ul>
</div>
</div>
<script src="/assets/javascript/contributing.js"></script>
</div>
</div>
</div>
<!-- Google Analytics -->
<!-- TODO -->
<!-- End Google Analytics -->
</body>
</html>