Add SECURITY.md to enable private vulnerability reporting#515
Open
lihnucs wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR adds
A
SECURITY.mdfile at the repository root, which:Why
Without a
SECURITY.md, security reporters have no official channel andmay resort to opening public issues, which exposes vulnerability details
before a fix is available.
Once this file is merged, GitHub will display a "Report a vulnerability"
button on the Security tab, giving reporters a confidential submission path
directly to the maintainers.
One follow-up step for maintainers
After merging, please enable Private vulnerability reporting under:
This activates the "Report a vulnerability" button that the SECURITY.md
references. Without this step the button will not appear.
Notes
[maintainer email]placeholder on line 22 should be replaced witha real contact address before or after merging