Skip to content

docs(security): add SECURITY.md disclosure policy#100

Merged
CryptoJones merged 1 commit into
masterfrom
docs/security-policy
May 18, 2026
Merged

docs(security): add SECURITY.md disclosure policy#100
CryptoJones merged 1 commit into
masterfrom
docs/security-policy

Conversation

@CryptoJones
Copy link
Copy Markdown
Owner

Summary

Adds SECURITY.md so reporters have a clear, documented path to disclose vulnerabilities responsibly:

  • GitHub Security Advisories (preferred for CVE-worthy issues)
  • Codeberg DM (for the mirror)
  • Maintainer email (last resort)
  • "Never open a public issue" is stated upfront

SLAs: acknowledge in 3 business days, triage in 7, fix high/critical in 30.

GitHub auto-surfaces the file under the repo's Security tab; Codeberg picks it up via the same convention.

Test plan

  • Documentation only — no code changes.

This code proudly made in Nebraska. GO BIG RED! 🌽 https://xkcd.com/2347/

Open-source projects with an embedded Snyk badge advertise an
intent to handle security carefully; a SECURITY.md formalizes the
disclosure path so reporters don't have to guess.

Contents:
- Supported versions: master-only single-track project.
- Reporting channels: GitHub Security Advisories (preferred);
  Codeberg DM; maintainer email as last resort. NEVER open a
  public issue.
- SLAs: acknowledge within 3 business days, triage within 7,
  fix high/critical within 30.
- Required content for reports: description, repro, affected
  commit, preferred attribution.
- In-scope and out-of-scope lists so casual scans don't generate
  noise reports.
- Disclosure timing: coordinate with the reporter, credit on the
  changelog entry.

GitHub auto-surfaces this file under the repo's Security tab;
Codeberg recognizes the same convention.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@CryptoJones CryptoJones merged commit 21fe42e into master May 18, 2026
3 checks passed
@CryptoJones CryptoJones deleted the docs/security-policy branch May 18, 2026 06:01
CryptoJones added a commit that referenced this pull request May 18, 2026
Contributor onboarding written down. Covers:

- Quick-start (clone, env setup, migrations, tests).
- Pre-PR checklist: lint, test, audit, OpenAPI updates, CHANGELOG.
- Commit-message conventions (conventional-commit prefixes,
  Co-Authored-By trailers for AI-assisted work).
- What gets reviewed: auth scoping, zod input validation, soft-
  delete defaults, no raw SQL, logger discipline, tests.
- What contributors DON'T need (no CLA, no specific IDE, etc.).
- Where to start (good-first-issue label, test-file headers as
  the convention reference, CHANGELOG architectural rationale).

Pairs with SECURITY.md (#100) to round out the open-source meta-
documentation set.

Co-authored-by: Aaron K. Clark <akclark@thenetwerk.net>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant