Skip to contents

Contributing

Source: CONTRIBUTING.md

Report a problem

Open an issue with the version or commit, operating system, reproduction steps, expected result, and observed result. Use a small synthetic example. Do not attach private data, credentials, or material you cannot redistribute. Report vulnerabilities through SECURITY.md.

Submit a change

  1. Fork the repository and create a branch for one change.
  2. Follow the setup and checks in README.md.
  3. Explain the change and the checks you ran in the pull request.
  4. For calculation or data changes, include an independent expected result, source provenance, units, and licence information.
  5. Keep generated output, caches, dependencies, and credentials out of Git.

Contributions use the repository’s existing MIT licence. Preserve third-party copyright, data licences, and attribution.

Commit authorship

Use the identity of the person responsible for reviewing and submitting the change. Development tools are not project contributors: do not add assistant signatures, tool accounts, or automatic tool co-author trailers. Keep credit for human contributors and licensed third-party work. Pull requests run an authorship check on newly introduced commits.

Conduct

Be respectful, explain technical disagreements, and avoid harassment or disclosing other people’s private information. Contact the maintainer at for concerns.