add vulnerability reporting steps - #16
Merged
Merged
Conversation
Signed-off-by: James Ranson <james@ranson.org>
Contributor
|
Should the security reporting go in this repo or in the parent? I have open several issues in the parent for the docs that are not yet completed like the SECURITY.md EarthSpark/.github#1 My understanding is that having them in the .github repo sets them as the default for all repos in the org. Same for the issue templates and all that. I think the License is the only thing that intentionally doesn't propagate. |
Contributor
Author
|
You can put the security file in the org repo. The main drawback to that is while it will populate all org projects' Security tabs, it will not be included in cloned copies of repo codebases alongside the license, contributing, etc. That could make it harder to find if someone is looking at an individual repo or a local clone. |
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.
Summary
This change adds a
SECURITY.mdfile that outlines the process for reporting security vulnerabilities, and points to it in the existing CONTRIBUTING.md.GitHub's
Security and qualitysection sources SECURITY.md, and this file is required to enable private vulnerability reporting outside of the normal Issue / Pull Request process.Related Issues
N/A
Testing
Tests pass on local worktree.
Checklist