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 uv.

4. Check the available Nox sessions:

   ./noxfile.py -l
   

5. Create a branch for local development:

   git switch -c name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

6. To check that your changes pass the project style checks, use prek:

   prek install
   prek run --all-files
   

7. 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
   

8. Submit a pull request through the GitHub website.

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

   changie new