Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Sign in to like and favorite skills
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
To make a contribution, follow the following steps:
For more details about pull requests, please read GitHub's guides.
We use
poetryPlease DO NOT use pip or conda to install the dependencies. Instead, use poetry:
poetry install --all-extras --with dev
To ensure our standards, make sure to install pre-commit before starting to contribute.
pre-commit install
We use
ruffmake format_diff
Make sure that the linter does not report any errors or warnings before submitting a pull request.
ruff-formatWe use
ruffmake format
We use
codespellmake spell_fix
We use
pytestmake test_all
If you prefer, you can run only the core tests with the command:
make test_core
or the test of extensions with the command:
make test_extensions
You can also run the tests with coverage by running the following command:
make test-coverage
Make sure that all tests pass before submitting a pull request.
At the moment, the release process is manual. We try to make frequent releases. Usually, we release a new version when we have a new feature or bugfix. A developer with admin rights to the repository will create a new release on GitHub, and then publish the new version to PyPI.