Thanks for your interest in contributing! This guide will help you get started.
Look for issues labeled good first issue or help wanted. Those are great for beginners.
- Fork the repository.
- Create a descriptive branch (e.g.
fix/readme-typo,feat/new-example). - Make your changes. Keep commits small and focused.
- If you added code, add or update tests in
tests/. - Run tests locally with
pytest(install withpip install -r requirements.txtif needed). - Push your branch and open a Pull Request (PR) on GitHub.
- In your PR description, explain what you changed and why.
- Keep it simple and readable.
- Use docstrings for functions.
- Follow PEP8 where practical.
If you're new to open source, comment on an issue saying you're working on it — maintainers may help.
By contributing, you agree your contribution will be licensed under the repository's MIT License.