Setting up your environment#

Get Started#

Ready to contribute? Here’s how to set up citric for local development.

  1. Fork the citric repo on GitHub.

  2. Clone your fork locally:

    git clone https://github.com/edgarrmondragon/citric.git
    cd citric
    
  3. Install nox (used for automation):

    pipx install nox
    nox -l
    
  4. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature
    

    Now you can make your changes locally.

  5. To check that your changes pass the project style checks, use pre-commit:

    pre-commit install
    pre-commit run --all-files
    
  6. Commit your changes and push your branch to GitHub:

    git add .
    git commit -m "Your detailed description of your changes."
    git push origin name-of-your-bugfix-or-feature
    
  7. Submit a pull request through the GitHub website.

  8. (Optional) Add a changelog entry using changie. You’ll need to install the Changie CLI in order to add a changelog entry:

    changie new