Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (23 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

29 lines (23 loc) · 1.15 KB
Raw

Contributing

Thank you for your interest in contributing to CatNet.

Before you start

  • Open an issue before large changes.
  • Keep changes focused and small.
  • Align with repository scope.
  • Prefer incremental pull requests.

Pull request checklist

  • Code builds successfully.
  • Tests pass locally.
  • Documentation is updated when applicable.
  • No unrelated files were changed.
  • The PR description explains what changed and why.

Scope rule

UI repositories must not duplicate core scanning logic.

Branching & Commit Policy (DevSecOps)

  • Collaboration Branch: The develop branch is the primary integration branch for development. All contributor pull requests must target develop.
  • Main Branch Restrictions: The main branch is reserved for stable releases. Pull requests targeting main must:
    • Come exclusively from develop.
    • Be automatically created by github-actions[bot].
  • Signed Commits: All commits in pull requests targeting main must be signed (GPG or SSH signature) to ensure verification and integrity.

Licensing

By contributing to this project, you agree that your contributions will be licensed under its MIT License.