19 lines (16 loc) · 838 Bytes

How to contribute

You'll need a copy of pixi and git in your machine. Then:

Clone this repo to disk.
Configure conda-forge to your channels if you haven't already:
```
conda config --add channels conda-forge
```
This ensures tests can find packages from conda-forge
pixi run test to run the tests. Choose your desired Python version by picking the adequate environment.
pixi run docs to build the docs and pixi run serve to serve them in your browser.
pixi run lint to run the pre-commit linters and formatters.

pixi run news to create a news file for your Pull Request.

pixi run news 476-deprecate-old-command --section "deprecations" --message "Mark old subcommand for deprecation. (#476)"

Note: Be sure to include updates to the changelog in your pull request.