Skip to content

docs: clean up SECURITY.md and add supported versions table#22

Open
Alexi5000 wants to merge 1 commit into
OpenKnots:mainfrom
Alexi5000:pr/security-md-cleanup
Open

docs: clean up SECURITY.md and add supported versions table#22
Alexi5000 wants to merge 1 commit into
OpenKnots:mainfrom
Alexi5000:pr/security-md-cleanup

Conversation

@Alexi5000
Copy link
Copy Markdown

Summary

Cleans up SECURITY.md and docs/SECURITY.md with three small documentation fixes.

Changes

  1. Remove dead HTML comment (line 11 of SECURITY.md) — stale email reference left behind during contact method switchover
  2. Add Supported Versions table — GitHub's standard security policy template format, showing which releases receive security updates
  3. Add cross-reference in docs/SECURITY.md — links back to the root policy so contributors who land on the runbook know where to report vulnerabilities

Why

First-time security reporters need to find the disclosure policy quickly. The dead comment is noise, the missing versions table leaves reporters guessing which versions to target, and the runbook has no pointer back to the policy.

Test Plan

  • Links in both files resolve correctly
  • No other files reference the removed email

- Remove stale HTML comment with old contact email
- Add Supported Versions section (GitHub standard policy format)
- Add cross-reference from docs/SECURITY.md runbook to the root
  disclosure policy so contributors land in the right place
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