All contributions are welcome, including typo fixes.
There might be a few TODO comments marking future intentions;
feel free to work on those.
See Code style and Project structure for more information on the project itself.
Clone this project with git clone, then install the package
in editable mode along with its dev dependencies:
$ pip install -e .[dev]This will install all packages necessary for development.
Whenever you make a fix,
remember to run the tests with pytest.
If everything passes, you are good to go.
$ pytestOtherwise, modify the tests as you go, and make sure that those pass as well.
The code must pass mypy, Pyright and PyCharm type checking. If you don't use PyCharm, you may ignore it. As stated in [Code style], use comments as necessary. For test files, test cases and "helper" functions may or may not be type hinted. Regardless, good type hints are always strongly and explicitly recommended.