Thanks for wanting to contribute. Please follow these simple guidelines.
- Read the repository README for setup and run instructions.
- Use the existing dependency workflow (uv) and a Python 3.11+ virtual environment.
- Format Python code to PEP8 and run tests with pytest.
- Open an issue to discuss large changes or design decisions.
- Create a branch per change, target the default branch with a clear PR title.
- Include tests for new behavior and make sure all tests pass.
- Keep changes small and focused.
- Link related issues/PRs in your pull request.
- Use PEP8 code formatting standard.
- Keep two blank lines between module-level functions and class definitions.
- Use 4 spaces per indentation level.
- Limit all lines to a maximum of 128 characters.
- When possible, put comments on a separate line.
- Use docstrings to describe all public modules, functions, classes, and methods.
- Break lines inside parentheses, brackets, and braces before binary operators.
- Avoid use of line continuations with a backslash.
- Avoid trailing spaces on line and trailing blank lines in files.
- Pull requests will be reviewed and may request changes before merging.
- Maintain a respectful and helpful tone in discussions.
- If unclear, open an issue or reach out in the repository.