CONTRIBUTING.md

How to contribute

Dependencies

First of all, you need to install python3.8 or higher. We recommend create a new conda and python3.10 for this project.

Create your conda environment, and then activate it:

conda create -n py-template python=3.10
conda activate py-template

We use poetry to manage the dependencies. If you don't have poetry, you should install with pip install poetry.

To install dependencies and prepare pre-commit hooks you would need to run install command:

make install
make pre-commit-install

Codestyle

After installation you may execute code formatting. We use ruff to format our code.

make format

Checks

Many checks are configured for this project. Command make check-codestyle will check using ruff.

Command make lint applies all checks.

Before submitting

Before submitting your code please do the following steps:

1. Add any changes you want
2. Add tests for the new changes
3. Edit documentation if you have changed something significant
4. Run make format to format your changes.
5. Run make lint to ensure that types, security and docstrings are okay.

Other help

You can contribute by spreading a word about this library. It would also be a huge contribution to write a short article on how you are using this project. You can also share your best practices with us.