Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (22 loc) · 787 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 787 Bytes
Raw

Contributing

Thank you for considering a contribution.

Ways to contribute

  • Report a bug.
  • Suggest a feature.
  • Improve documentation.
  • Add tests or examples.
  • Review architecture or usability decisions.

Development workflow

  1. Open an issue or discuss the change with the maintainers.
  2. Create a branch from main.
  3. Make a small, reviewable change.
  4. Add or update tests and documentation.
  5. Open a pull request using the PR template.

Pull request expectations

  • The purpose of the change is clear.
  • Tests or validation steps are included when relevant.
  • Documentation is updated when behavior changes.
  • Scientific assumptions and limitations are documented.
  • New dependencies are justified.

Maintainers

TODO: Add maintainer names and contact route.