Setting up your environment#
Get Started#
Ready to contribute? Here’s how to set up citric
for local development.
Fork the citric repo on GitHub.
Clone your fork locally:
git clone httpshttps://github.com/edgarrmondragon/citric.git
Install
poetry
and the project dependencies:poetry install
Install
nox
(used for automation):pipx install nox pipx inject nox nox-poetry nox -l
To check that your changes pass the project style checks, use
pre-commit
:pre-commit install
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
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
Submit a pull request through the GitHub website.
(Optional) Add a changelog entry using
changie
. You’ll need to install the Change CLI in order to add a changelog entry:changie new