Skip to content

Add SECURITY.md and notes on PVR#372

Open
andyblundell wants to merge 1 commit intomainfrom
anbl-add-security-md
Open

Add SECURITY.md and notes on PVR#372
andyblundell wants to merge 1 commit intomainfrom
anbl-add-security-md

Conversation

@andyblundell
Copy link
Copy Markdown
Contributor

Summary

Adds a SECURITY.md file to the repository and documents best practices for allowing others to report security problems.

Changes

Added SECURITY.md

  • Provides guidance on how to report security vulnerabilities
  • Uses GitHub's Private Vulnerability Reporting (PVR) as the primary reporting method
  • Includes a direct link to the vulnerability reporting form for ease of use
  • Retains contact details for general security enquiries

Updated practices/securing-repositories.md

Added a new section "Allowing others to report security problems" covering:

  • Adding a SECURITY.md file to repositories
  • Enabling Security advisories
  • Enabling Private vulnerability reporting for public repositories
  • Monitoring and acting on security advisories

Also links to this repository's SECURITY.md as a working example.

Why

Public repositories should make it easy for security researchers and users to report vulnerabilities privately. GitHub's Private Vulnerability Reporting provides a low-friction, secure channel that doesn't require external reporters to manage email or tokens — they just need a GitHub account.

Checklist

  • SECURITY.md added to repository root
  • Private vulnerability reporting enabled in repository settings
  • Documentation updated with guidance for other teams

@andyblundell andyblundell requested a review from a team as a code owner April 15, 2026 17:29
@sonarqubecloud
Copy link
Copy Markdown

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