How to contribute

Guide on how to contribute to this project

First off, thanks for taking the time to contribute!

General Feedback

If you have a general feedback about our project, please do not open an issue but instead please fill in this form

Code of Conduct

Available here

Code style

We use ruff to enforce the code style and code formatting. You can run it with:

pipenv run ruff check .
pipenv run ruff format .

To ensure that the code is formatted correctly, we use a pre-commit hook that runs Ruff before every commit. Run the following once to enable hooks in your local repo:

pipenv run pre-commit install
# optional: run on all files
pipenv run pre-commit run --all-files

Hence, you will need to make sure that the code is formatted correctly before committing your changes; otherwise, the commit will fail. More information about pre-commit hooks can be found here.

Submitting changes

Please send a Pull Request with a clear list of what you've done. Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact."

Thanks

Thank you again for being interested in this project! You are awesome!