|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Thank you for your interest in contributing to Alon Sentinel. |
| 4 | + |
| 5 | +## Contributor License Grant |
| 6 | + |
| 7 | +By submitting a pull request, issue, patch, documentation change, suggestion, |
| 8 | +or any other contribution to this repository, you agree that: |
| 9 | + |
| 10 | +1. Your contribution is your original work, or you otherwise have the right to |
| 11 | + submit it under these terms. |
| 12 | +2. You grant Tomislav Nekic and the Alon Sentinel project a perpetual, |
| 13 | + worldwide, non-exclusive, royalty-free, irrevocable license to use, |
| 14 | + reproduce, modify, prepare derivative works of, publicly display, |
| 15 | + publicly perform, and distribute your contribution as part of Alon Sentinel |
| 16 | + under the GNU Affero General Public License v3.0 or later. |
| 17 | +3. This grant allows the contribution to be used under the same AGPL terms as |
| 18 | + the rest of the project. |
| 19 | +4. This grant does not transfer copyright ownership. You keep your own rights |
| 20 | + to use your contribution for any purpose. |
| 21 | + |
| 22 | +This lightweight contributor license grant keeps contributions usable under the |
| 23 | +project license. |
| 24 | +If you cannot agree to this, please do not submit a contribution. Open an issue |
| 25 | +to discuss the idea instead. |
| 26 | + |
| 27 | +## How to contribute |
| 28 | + |
| 29 | +- **Bug reports:** open a GitHub issue with steps to reproduce and expected vs. |
| 30 | + actual behavior. |
| 31 | +- **Feature requests:** open an issue describing the use case, not just the |
| 32 | + requested feature. |
| 33 | +- **Pull requests:** open an issue first for anything non-trivial so we can |
| 34 | + align before you invest time. |
| 35 | + |
| 36 | +## Code style |
| 37 | + |
| 38 | +- Rust: `cargo fmt` and `cargo clippy` must pass before submitting. |
| 39 | +- TypeScript: `npm run lint` must pass. |
| 40 | +- Keep changes focused: one concern per PR. |
| 41 | + |
| 42 | +## What gets accepted |
| 43 | + |
| 44 | +Priority is given to: |
| 45 | + |
| 46 | +- Bug fixes with a clear reproduction case |
| 47 | +- Performance improvements with measurements |
| 48 | +- Documentation improvements |
| 49 | + |
| 50 | +Features may be declined if they conflict with the product direction or belong |
| 51 | +outside the project's scope. When in doubt, ask first. |
0 commit comments