Contribute

Make one focused improvement at a time.

Contributions should be scoped, tested and connected to a documented use case.

Before opening a merge or pull request

  1. Check the project README, open issues and current release status.
  2. Open an issue for changes that affect public APIs or architecture.
  3. Keep a merge or pull request limited to one technical objective.
  4. Add or update unit and integration tests.
  5. Update documentation and changelog entries when behavior changes.

Expected quality

  • Formatting, linting and static analysis pass locally.
  • Public APIs use explicit types and documented failure behavior.
  • No secrets, private endpoints or environment-specific values are committed.
  • Commit and merge or pull request descriptions explain intent, not only implementation.

Security reports

Do not publish exploitable security details in a public issue. Use the private reporting mechanism documented by the affected project.