How To Contribute to NAIRR Community Resources Documentation (Git)

Refer to GitHub’s documentation for the Fork & Pull Request workflow for more information.

  1. Login to GitHub

  2. Copy SSH key to GitHub (optional)

  3. Fork the NAIRRProgram/nairr repository (https://github.com/NAIRRProgram/nairr) and create a working branch.

    1. Click on the “Fork” button near the top-right of the repository page.

      • You only need to fork the repository once. If already forked during a previous change, skip this step and move on to creating a branch.

  4. Clone the fork locally

    1. Navigate to your github fork of the repository

    2. Click Code -> Copy git clone <fork_url> command. Use the SSH link if you’ve uploaded an SSH key, otherwise use http

    3. In your local machine terminal, run git clone with the copied line

  5. Setup environment

    1. Create and activate a virtual environment

    2. pip install -r requirements.txt

  6. Make edits

    1. Use your editor or IDE of choice

  7. Preview changes

    1. cd docs

    2. make html

    3. Navigate in file browser to index.html

  8. Repeat edits and preview as until changes are ready

  9. Commit changes

    1. git add <files>

    2. git commit -m 'message describing your changes here'

  10. Push to fork

    1. set upstream - following github documentation

    2. git push (to your fork)

  11. Open Pull Request for main

    1. Navigate to fork on GitHub

    2. Open Pull Request