Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

48 lines (30 loc) · 1.24 KB

Contributing Guidelines

We welcome small, well-scoped contributions to this project. We're keeping the scope tight and focused.

Please read the following notes before submitting a pull request or issue.

Issues

  • Tag your issue with one of: bug, feature request, or question
  • Keep issues concise and reproducible when possible
  • Maintainer response times may be slow depending on bandwidth

Pull Requests

We accept:

  • Bug fixes
  • Small, testable improvements
  • Minor documentation updates

We do not accept:

  • API redesigns
  • Major refactors
  • Subsystem rewrites

All contributions are reviewed via GitHub pull requests. See GitHub Help if you're unfamiliar with the process.

Code Review

  • All submissions require review
  • Pre-commit checks (formatting, linting, etc.) must pass before merge
  • Run scripts/format_code.sh before committing. It checks formatting and installs required tools if missing.
  • You can install dev tools manually with: pip install -r requirements-dev.txt
  • Include or update tests if applicable

Contributor License Agreement (CLA)

We do not require a CLA. Contributions must be easy to verify and are accepted at our discretion.