1. Overview

Below is an overview of the process of contributing to FTC Docs.

Warning

Using Codespace and working Locally are two different ways to contribute to FTC Docs. The steps for each are similar, but there are key differences in setup. After reading step 2, you should choose whether you want to use Codespaces or work locally. For the purposes of this guide, Local and Codespaces use will be mutually exclusive.

Key

One Time Only	Repeat	Codespaces	Local	Information
Step only needs to be done once	Step must be repeated for each set of changes	Step specific to Codespaces users	Step specific to Local users	General information that provides context

2. Intro to Codesapces Information

   • This will provide an overview of Codespaces and how to use them.

3. Getting to know the GitHub Repository Information

   • This will provide an overview of the FTC Docs repository and how it is organized. This is important to understand before you start working on a contribution.

4. Fork the repository One Time Only Codespaces Local

   • This will create a copy of the FTC Docs repository in your GitHub account.

5. Update the repository Repeat Codespaces Local

   • This will update your fork with the latest changes from the FTC Docs repository. This is important to do before you start working on a new contribution.

6. Set up your environment One Time Only Local

   • This will set up your local environment to work on FTC Docs. This step can be skipped for Codespaces users.

7. Create a new branch Repeat Codespaces Local

   • This will create a new branch for your change. You should create a new branch for each change you work on.

8. Create a new codespace Repeat Codespaces

   • This will create a new Codespace for your change. You should create a new Codespace for each change/branch you work on.

9. Switch to your branch Repeat Local

   • This will switch to the branch you created in step 7. You should switch to the branch you created for each change you work on.

10. VS Code Tasks Information

    • This will provide an overview of the tasks for FTC Docs available in VS Code. This is important to understand before you start working on a contribution.

11. Make your changes Repeat Codespaces Local

12. Setup Git Credentials One Time Only Local

    • This will set up your Git credentials so you can push your changes.

13. Submit your changes Repeat Codespaces Local

    • Commit your changes and submit a pull request to the FTC Docs repository.