Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (31 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

47 lines (31 loc) · 1.41 KB

How to contribute

Dependencies

We use uv to manage the dependencies. If you don't have uv, you should install with make uv-download or follow the official installation guide.

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

make install
make pre-commit-install

To activate your virtual environment, uv will automatically handle it when running commands with uv run.

Codestyle

After installation you may execute code formatting.

make codestyle

Checks

Many checks are configured for this project. Command make check-codestyle will check black, isort and darglint. The make check-safety command will look at the security of your code.

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