Create SECURITY.md for security policy#8827
Open
HK4zCzi wants to merge 2 commits into
Open
Conversation
Added a security policy document outlining supported versions and vulnerability reporting.
|
|
Contributor
Reviewer's GuideAdds a new SECURITY.md document that outlines a template security policy including supported versions and guidance for reporting vulnerabilities. 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 found 1 issue, and left some high level feedback:
- The
Supported Versionstable appears to use placeholder versions (5.x/4.x); consider updating this to match the actual release/versioning scheme used in the project so the policy is actionable. - The
Reporting a Vulnerabilitysection still contains template guidance text; replace this with concrete instructions (e.g., email address, security disclosure process, expected response timelines) tailored to this project.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The `Supported Versions` table appears to use placeholder versions (5.x/4.x); consider updating this to match the actual release/versioning scheme used in the project so the policy is actionable.
- The `Reporting a Vulnerability` section still contains template guidance text; replace this with concrete instructions (e.g., email address, security disclosure process, expected response timelines) tailored to this project.
## Individual Comments
### Comment 1
<location path="SECURITY.md" line_range="5-6" />
<code_context>
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported |
</code_context>
<issue_to_address>
**suggestion (typo):** Consider simplifying the phrase "about which versions" to "which versions" for smoother grammar.
Rephrasing to “Use this section to tell people which versions of your project are currently being supported with security updates.” reads more naturally and avoids the clunky “about which” wording.
```suggestion
Use this section to tell people which versions of your project are
currently being supported with security updates.
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
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.
Added a security policy document outlining supported versions and vulnerability reporting.
Feature Preview
PR Checklist
Summary by Sourcery
Documentation: