First off, thanks for taking an interest in this project. We are glad about usage, ideas, and contributions to help us develop something everyone enjoys using.
For general questions and unstructured discussion, come see us in our chat room.
- The project board shows the current roadmap and the progress on specific issues
- The project docs on github pages
- PEP 484 introduced type hinting to python
- PEP 526, PEP 544, PEP 560, PEP 563, and PEP 586 extended it
- mypy is used as reference for type annotation checks
Install poetry and run
poetry install in the project root. This will perform a dev-install of
the project in a new virtual environment, which should be all you need
to do to start contributing.
If your shell can't find the virtual env on its own, run poetry shell,
after which all tools and the stenotype cli should work properly.
Any pull request needs to pass
the CI
before it can be merged. The most important ones are formatting (black src/ tests/), unit tests (pytest tests/), and static typing (mypy src/), be sure to run those commands locally before every push.
For details, check the tooling section of the docs.
In general, pull requests should happen to solve an issue with the project. Any content-related discussion regarding the issue should take place on the issue itself, and comments on the pull request should all broadly fall under code-review guidelines.
An issue can be created for any of the following cases:
- bug - make sure it is reproducible
- enhancement - aka feature request
- question - whatever you feel like asking
If you plan to write one, please take care that yours falls among them and tag it accordingly.