Contributing
Contributions are very welcome; please contact us by email or by filing an issue in our repository. All contributors must abide by our code of conduct.
Setup and Operation
- Install uv
- Create a virtual environment by running
uv venvin the root directory - Activate it by running
source .venv/bin/activatein your shell - Install dependencies by running
uv pip install -r pyproject.toml
| make task | effect |
|---|---|
| clean | clean up |
| commands | show available commands (default) |
| format | re-format code |
| lint | check code and project |
FAQ
- Do you need any help?
- Yes—please see the issues in our repository.
- What sort of feedback would be useful?
- Everything is welcome, from pointing out mistakes in the code to suggestions for better explanations.
- How should contributions be formatted?
- Please use Conventional Commits.
Contributors
- Greg Wilson is a programmer, author, and educator based in Toronto. He was the co-founder and first Executive Director of Software Carpentry and received ACM SIGSOFT's Influential Educator Award in 2020.