Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (23 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

29 lines (23 loc) · 1.25 KB

Contributing

Thanks for contributing! This repo is security-sensitive by design: it influences how humans and agents behave.

Ways to contribute

  • Improve AGENTS.md rules (clarity, enforceability, modern threats)
  • Add language/framework-specific secure snippets (in docs/)
  • Improve workflows (Scorecard, Dependabot) without weakening security
  • Fix typos and improve documentation quality

Ground rules

  • No secrets in issues/PRs.
  • Security-relevant changes must be justified with threat/risk reasoning.
  • Keep diffs small and focused (one concern per PR).

Pull request process

  1. Open a PR with a clear title and scope.
  2. Fill out the PR checklist (template will appear automatically).
  3. Maintainers will review. Security posture must not regress.

Publishing this template

If you fork or publish this repo as a template:

  • Update the security report URL in .github/ISSUE_TEMPLATE/config.yml to your repo's Security tab.
  • Update .github/CODEOWNERS with your maintainer handles (or remove if not using CODEOWNERS).
  • Ensure GitHub Private Vulnerability Reporting is enabled in repo Settings → Security.

Style

  • Markdown: clear headings, short paragraphs, checklists where helpful
  • Prefer “MUST/SHOULD/MAY” language for enforceable rules