Skip to content

docs: add SECURITY.md with private disclosure policy#98

Open
Pazificateur69 wants to merge 1 commit into
init4tech:mainfrom
Pazificateur69:docs/security-policy
Open

docs: add SECURITY.md with private disclosure policy#98
Pazificateur69 wants to merge 1 commit into
init4tech:mainfrom
Pazificateur69:docs/security-policy

Conversation

@Pazificateur69
Copy link
Copy Markdown

Why

While reading the zenith contracts I noticed there is no SECURITY.md
at the repo root and no .github/SECURITY.md. Without a clear,
linkable disclosure policy, well-intentioned researchers may either
open public issues (bad) or have no obvious channel to use at all.

What

Adds a minimal SECURITY.md that:

  • Points reporters at GitHub's built-in Private Vulnerability
    Reporting

    feature (no third-party emails hard-coded — leaves contact details
    to maintainers, who can add a security email or PGP key on top of
    this template if preferred).
  • Suggests a 90-day default disclosure window, extendable at
    maintainers' discretion.
  • Defines scope (src/ in; lib/ and test/ out).
  • Notes no formal bug bounty exists today.

Notes

  • Pure docs change, no code touched.
  • Happy to revise tone / wording / scope to fit any conventions the
    init4tech org already uses elsewhere — I just couldn't find a
    template in .github/ or in the org-wide .github repo.
  • If a policy already exists somewhere I missed, feel free to close
    this PR; no offense taken.

Adds a minimal SECURITY.md so that researchers have a clear,
non-public channel for reporting vulnerabilities. Uses GitHub's
built-in Private Vulnerability Reporting feature, leaving any
preferred email or PGP key to be added by maintainers as needed.

Industry-standard 90-day disclosure window mentioned as a default,
extendable at maintainers' discretion.
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