|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Thank you for your interest in contributing! Here's how to get started. |
| 4 | + |
| 5 | +## Getting Started |
| 6 | + |
| 7 | +1. Fork the repository |
| 8 | +2. Clone your fork locally |
| 9 | +3. Install dependencies: |
| 10 | + |
| 11 | + pip install -e . |
| 12 | + pip install pytest |
| 13 | + |
| 14 | +4. Run the tests to confirm everything works: |
| 15 | + |
| 16 | + PYTHONPATH=. pytest tests/ -v |
| 17 | + |
| 18 | +## Making Changes |
| 19 | + |
| 20 | +1. Create a new branch: |
| 21 | + |
| 22 | + git checkout -b fix/your-fix-name |
| 23 | + |
| 24 | +2. Make your changes |
| 25 | +3. Add or update tests to cover your changes |
| 26 | +4. Run the full test suite — all tests must pass |
| 27 | +5. Commit with a clear message: |
| 28 | + |
| 29 | + git commit -m "fix: description of what you fixed" |
| 30 | + |
| 31 | +6. Push and open a Pull Request against main |
| 32 | + |
| 33 | +## Pull Request Guidelines |
| 34 | + |
| 35 | +- Keep PRs focused — one fix or feature per PR |
| 36 | +- All tests must pass before merging |
| 37 | +- Add tests for any new functionality |
| 38 | +- Update the README if you add new features or change the API |
| 39 | +- Use clear, descriptive commit messages |
| 40 | + |
| 41 | +## Reporting Issues |
| 42 | + |
| 43 | +Please open a GitHub Issue with: |
| 44 | +- A clear description of the problem |
| 45 | +- Steps to reproduce it |
| 46 | +- Expected vs actual behavior |
| 47 | +- Your Python version and OS |
| 48 | + |
| 49 | +## Code Style |
| 50 | + |
| 51 | +- Follow existing code style in the repo |
| 52 | +- Use type hints where possible |
| 53 | +- Add docstrings to public functions and classes |
| 54 | +- Keep functions focused and single-purpose |
| 55 | + |
| 56 | +## License |
| 57 | + |
| 58 | +By contributing, you agree that your contributions will be licensed |
| 59 | +under the MIT License. |
0 commit comments