Create SECURITY.md#2
Merged
Merged
Conversation
Contributor
Reviewer's GuideAdds an initial SECURITY.md documenting supported versions and a template for reporting vulnerabilities. Flow diagram for vulnerability reporting lifecycle described in SECURITY.mdflowchart TD
A[Security researcher discovers vulnerability] --> B[Researcher opens SECURITY_md]
B --> C[Check supported versions table]
C --> D{Version supported?}
D -->|Yes| E[Follow reporting instructions in SECURITY_md]
D -->|No| F[Consider reporting with lower priority or informational context]
E --> G[Project maintainers receive report]
G --> H[Assess and triage vulnerability]
H --> I{Vulnerability accepted?}
I -->|Yes| J[Plan and implement fix for supported versions]
I -->|No| K[Communicate decision and reasoning to reporter]
J --> L[Publish fix and, if applicable, advisory]
L --> M[Update SECURITY_md support table if needed]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The SECURITY.md still contains placeholder template text (e.g., “Use this section to tell people...”)—replace these with concrete project-specific guidance on supported versions and security update policy.
- The reporting section should be updated with an actual vulnerability reporting channel (e.g., security email, issue tracker link, response SLA) instead of the generic instructions.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The SECURITY.md still contains placeholder template text (e.g., “Use this section to tell people...”)—replace these with concrete project-specific guidance on supported versions and security update policy.
- The reporting section should be updated with an actual vulnerability reporting channel (e.g., security email, issue tracker link, response SLA) instead of the generic instructions.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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 by Sourcery
Documentation: