Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (38 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

51 lines (38 loc) · 1.9 KB
Raw

Contributing

Thank you for your interest in contributing to Alon Sentinel.

Contributor License Grant

By submitting a pull request, issue, patch, documentation change, suggestion, or any other contribution to this repository, you agree that:

  1. Your contribution is your original work, or you otherwise have the right to submit it under these terms.
  2. You grant Tomislav Nekic and the Alon Sentinel project a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license to use, reproduce, modify, prepare derivative works of, publicly display, publicly perform, and distribute your contribution as part of Alon Sentinel under the GNU Affero General Public License v3.0 or later.
  3. This grant allows the contribution to be used under the same AGPL terms as the rest of the project.
  4. This grant does not transfer copyright ownership. You keep your own rights to use your contribution for any purpose.

This lightweight contributor license grant keeps contributions usable under the project license. If you cannot agree to this, please do not submit a contribution. Open an issue to discuss the idea instead.

How to contribute

  • Bug reports: open a GitHub issue with steps to reproduce and expected vs. actual behavior.
  • Feature requests: open an issue describing the use case, not just the requested feature.
  • Pull requests: open an issue first for anything non-trivial so we can align before you invest time.

Code style

  • Rust: cargo fmt and cargo clippy must pass before submitting.
  • TypeScript: npm run lint must pass.
  • Keep changes focused: one concern per PR.

What gets accepted

Priority is given to:

  • Bug fixes with a clear reproduction case
  • Performance improvements with measurements
  • Documentation improvements

Features may be declined if they conflict with the product direction or belong outside the project's scope. When in doubt, ask first.