-
Install the
uvpackage manager -
Clone the project locally
-
Run:
uv sync --all-extras --all-groups --inexact
Or run (Unix-based systems only):
make install
-
Update the changelog
-
Make sure to run the
pre-commitcommand to lint and format the code (automatically installed in the Local Development step) -
We use Codecov (code coverage service) to report the test coverage of your changes. We have a strict 100% coverage, meaning that all the code is covered by tests. Please test all your changes and test them hastily, don’t test just for the sake of testing and to get a proper coverage. We want the tests to prevent any error and any potential breaking from changes!
-
Finally, make sure you are using the latest version of the dependencies and that you have read our documentations.
-
If you need to test the documentation, you can run the following commands:
$ cd docs/ $ make buildThen, open
_build/index.htmlin your browser.