Contributing#

Code#

To be able to import the package under development in the Python REPL, run the following:
```
pip install -U pip setuptools -e .
```

pip install pre-commit
pre-commit install

this will be checked with a github action, if you don’t format it, the checks will fail

Document your code, write tests if needed, use feature branches to contribute.

To run tests use tox: Literally just:
```
tox
```
And to run the linter:
```
tox -e lint
```

Documentation Improvements#

nptr-cli uses sphinx for documentation, the documentation is written inside of the docstrings. It is also configured to use CommonMark with the MyST extension.

When working on documentation changes in your local machine, you can compile them using tox:

tox -e docs

the output files are in docs/_build/html