The diagram below helps visualize where we will work on the process. Initially work will be in GitHub, getting a fork (copy) of the Adafruit Learning System repository (repo for short). Then with git on your local computer, you will clone that fork, commit your additions, deletions, and edits, then push your changes back to your fork then finally create a Pull Request back to the Learning System repo.

I know the terminology may seem a bit strange - see the Glossary page in this guide for the meaning of each word.

This may help for the Adafruit Learning System:

The Repository (upstream) is the Adafruit Learning System on GitHub

The Repository (personal fork) is on your own GitHub account and is a copy of the Adafruit repository.

The Repository (local copy) is on your home or work computer. You will clone files from the Repository (personal fork) and push them back so you're working within your own ecosystem and not Adafruit's.

If You Have a Repository (local copy) of the Adafruit Learning System already on your own computer

If you have previously done work on the Adafruit Learning System and you're going to do more work, please skip to and follow the page Staying Up To Date later in this guide to ensure you are working with the latest copy of the files. This will save many headaches if there is a conflict because your local copy was out of date compared to GitHub.

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

This page (Workflow) was last updated on Mar 08, 2024.

Text editor powered by tinymce.