Skip to content

Latest commit

 

History

History
64 lines (64 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

64 lines (64 loc) · 3.16 KB
Raw

Contributing to Arduino MicroPython Package Index

​

Adding a package to the MicroPython Package Index

​ If you would like to make a package available for installation via the MicroPython Package Index, just submit a pull request that adds the repository URL to the list. You are welcome to add multiple packages at once. ​ See below for detailed instructions on how to do this via the GitHub web interface. ​

Instructions

​

  1. Open this link to fork this repository and edit the list via the GitHub web interface: https://github.com/arduino/package-index-py/edit/main/package-list.yaml
  2. Click the Fork this repository button.
  3. Add the an aptly formatted section at the bottom of package-list.yaml.
  4. Check that indentation follows the previous sections.
  5. Click the Commit changes button.
  6. In the "Comparing changes" window that opens, click the Create pull request button.
  7. Add a meaningful title.
  8. Fill in the description which will be used for review.
  9. Click the Create pull request button. ​ ​

Package entry example

- arduino-iot-cloud-py:
    name: Arduino IoT Cloud Python client
    url: https://github.com/arduino/arduino-iot-cloud-py
    author: Developer or maintainer descriptor
    description: A Python client for the Arduino IoT cloud, which runs on both CPython and MicroPython.
    tags: ["cloud", "iot"]

​ ​ Your entry will be automatically checked for correct formatting as soon as the pull request is submitted. If no problems were found, the pull request will be reviewed as quickly as possible. Please allow for a bit of time on our end since this process is currently manual. ​ If there are any formatting errors, they will be reported in the Pull Request thread. Please check your entry if this is the case. ​ ​

Changing the URL of a package already in MicroPython Package Index

​ Submit a pull request that changes the URL as desired in package-list.yaml. This can be done by following the instructions above. ​ Since this type of request must be reviewed by a human maintainer, please write an explanation in the pull request description, making it clear that the URL is intentionally being changed. ​

Removing a package from MicroPython Package Index

​ Submit a pull request that removes the URL from package-list.yaml. This can be done by following the instructions above. ​ Since this type of request must be reviewed by a human maintainer, please write an explanation in the pull request description, making it clear that the URL is intentionally being removed or changed. ​

Report a problem with MicroPython Package Index

​ This repository is not an appropriate place to request support or report problems with a package. Check the package's own documentation for instructions. ​ If the problem is about something else, please submit an issue report here.