Skip to content

Latest commit

 

History

History
69 lines (41 loc) · 1.93 KB

File metadata and controls

69 lines (41 loc) · 1.93 KB

Contributing to httpsig-rs

Thank you for your interest in contributing to httpsig-rs!

This project is maintained primarily based on the maintainer's personal interests and research activities. Contributions are handled on a best-effort basis.


Reporting issues

  • Use the appropriate Issue template if available.
  • Please provide enough information to reproduce the problem.
  • Include logs, environment details, and minimal reproduction cases whenever possible.

Pull Requests

Contributions are welcome, but please keep the following in mind:

  • Keep changes minimal, focused, and easy to review.
  • Avoid mixing unrelated changes in a single PR.
  • Do not mix formatting-only changes with functional changes.
  • Please avoid unrelated formatting changes, since the maintainer may use different formatting preferences or toolchain settings.
  • Security-sensitive changes must be isolated and reviewable.

Large cleanup/refactor/performance PRs may be closed without review.


AI-assisted contributions

AI-assisted contributions are allowed, but contributors are fully responsible for the submitted changes.

Please minimize reviewer burden:

  • understand every non-trivial part of the change,
  • explain the rationale clearly,
  • and avoid large generated patches containing unrelated modifications.

Do not submit generated patches that you cannot personally explain and justify.


Security reports

Do not open public Issues for security vulnerabilities.

Please use:

  • GitHub Private Vulnerability Reporting
  • or another private contact method if available.

Code of Conduct

Be respectful and constructive.

Aggressive, hostile, or entitled communication may result in Issues or PRs being closed without further discussion.


Final notes

Maintainer time and review capacity are limited.

Contributions that are minimal, well-scoped, and easy to review are much more likely to be accepted.

Thank you for supporting httpsig-rs.