Contributing
Last updated
Thank you for considering a contribution. These rules apply to every repository under AlexGromer. If a repository has its own CONTRIBUTING file, that file wins.
Before you start
- Search the existing issues and pull requests first.
- For anything larger than a typo or an obvious fix, open an issue and describe the problem before writing code. It saves us both time.
- Security problems do not belong in public issues: see the security policy.
Pull requests
- Small and focused: one concern per pull request, no drive-by reformatting, no unrelated fixes. Mention side findings separately.
- Prefer the simple solution that works over the complete one that does not ship (worse is better).
- Add or update tests. Run the project's checks locally. A failing test means the code is wrong; do not skip or disable tests to get green.
- Never commit secrets, tokens or personal data.
Commits
- Sign your commits (GPG or SSH signature). Where a repository enforces it, unsigned commits are not merged.
- Write the subject in the imperative, and explain why the change is needed, not only what it does.
- Keep history readable; I may ask you to squash or reorder.
Review
- I review on a best-effort basis and aim for a first answer within 7 days. There is no guarantee.
- I may ask you to narrow the scope, split the change, or take another approach. The maintainer's decision is final, and I will say why.
- A pull request with no activity for 30 days after a review may be closed; you are welcome to reopen it.
Licence of contributions
Your contribution is licensed under the licence of the repository you contribute to. By opening a pull request you confirm you have the right to do that.
Behaviour
Everyone taking part is expected to follow the code of conduct.