We love contributions! Please follow these steps before opening a Pull Request:
- Fork the repository and clone your fork locally.
- Create a new branch for your feature or bug‑fix:
git checkout -b my‑awesome‑feature
- Install the development environment:
python -m venv venv .\\venv\\Scripts\\activate # PowerShell pip install -r requirements.txt -r dev-requirements.txt
- Run the test suite to ensure nothing is broken:
python -m pytest
- Make your changes adhering to the existing code style (PEP‑8, type hints).
- Update documentation (README, docs, or tool docstrings) if you add new functionality.
- Commit with a clear message and push to your fork:
git push origin my‑awesome‑feature
- Open a Pull Request against the
mainbranch. Include:- Short description of what the PR does.
- Reference to any related issue (
Fixes #123). - Screenshots or GIFs if UI changes are involved.
All contributors must follow the CODE_OF_CONDUCT.md.
Maintainers will review your PR within 3‑5 business days. If changes are required, they will be requested in the PR comments.
If you have any questions, feel free to reach out at gyodragos@gmail.com or open an issue on GitHub.