If you are not comfortable using git or GitHub, it is perfectly ok to coordinate with your Adafruit guide facilitator and provide your code to them. There are some guidelines we'd like to have with your code:

1. Ensure it compiles with the latest downloadable Arduino IDE (not the online Create site). 

2. At the top of each source file (.ino, possibly .h and/or .cpp files), you need a header with the author and license information (as noted previously in this guide).

3. Note to your facilitator what microcontroller board your code runs on. Most often this is an Adafruit board but it could be others.

4. If you have code that runs on different microcontrollers, re. one for Circuit Playground Express and one for Feather SAMD21, please note which is which as the code will be placed in separate directories within the main repository for the guide.

What Will Happen

Your facilitator will copy your code into the Adafruit Learning System GitHub repository at https://github.com/adafruit/Adafruit_Learning_System_Guides.

The code will be set up in one directory, with separate subdirectories as needed for data, etc. If there is code for more than one microcontroller type or multiple examples, these may be put in subdirectories.

The code will be processed by the Continuous Integration (CI) process which essentially uses a command line version of the Arduino IDE to compile your code along with necessary libraries.

If your code does not compile:

Your facilitator will let you know what errors are encountered and the author is expected to fix issues and send corrections back to the facilitator.

When Your PR is Merged

When your code has completed CI and Adafruit has merged your PR, you can go to GitHub and get links to your main source files for inclusion in your guide. See the next page for instructions.

This guide was first published on Oct 19, 2021. It was last updated on Mar 08, 2024.

This page (Send Code to Your Facilitator) was last updated on Mar 08, 2024.

Text editor powered by tinymce.