Thank you for helping improve battlezone. Contributions are easiest to review when they are focused, tested, documented, and safe for protected branches.
Use pull requests for all non-trivial changes.
- Create a topic branch from the default branch.
- Keep each pull request focused on one bug fix, feature, or documentation update.
- Use Conventional Commits for commit messages and pull request titles.
- Sign every commit with a GitHub-supported signature method such as SSH or GPG.
- Add or update tests for behaviour changes where the repository has a test suite.
- Update documentation when behaviour, configuration, installation, or developer workflow changes.
- Remove credentials, tokens, private keys, personal data, and private environment details from code, tests, logs, and screenshots.
Maintainers review pull requests before merge. Direct pushes to protected branches should be limited to maintainers and automation that has passed the required checks.
Use this format:
type(scope): short imperative summary
Common types include feat, fix, docs, test, refactor, ci, and chore.
Run the repository's local validation before requesting review. Prefer the Makefile target when the repository provides one, because that keeps local and CI checks aligned.
Every behaviour change should include an appropriate test or a clear note explaining why automated coverage is not practical. Keep changes small enough that reviewers can understand the risk.
These guardrails keep the repository safe for outside contributions:
- Require pull requests before merging to protected branches.
- Require maintainer review for external contributors.
- Keep CI permissions as narrow as possible.
- Avoid running untrusted pull request code with write-scoped secrets.
- Prefer dependency updates through Dependabot or similarly reviewed automation.
Contributors are expected to follow CODE_OF_CONDUCT.md.