-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Create SECURITY.md #1910
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Create SECURITY.md #1910
Conversation
WalkthroughA new SECURITY.md file is introduced containing security policy documentation. The file includes a table of supported versions with their statuses and a section with guidance for reporting vulnerabilities and expected handling timelines. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@SECURITY.md`:
- Around line 17-21: Replace the placeholder text in SECURITY.md with a concrete
vulnerability reporting procedure: specify the exact contact method (e.g.,
security@your-company.com, a security portal URL, or GitHub Security Advisories)
and any PGP/key for encrypted reports, state an expected response timeline
(e.g., "acknowledge within 48 hours, update every 7 days"), define the
disclosure policy and timeline for coordinated disclosure, describe what
reporters should include (impact, reproduction steps, affected versions), and
outline the process for accepted vs. declined reports (triage, remediation
timeline, public disclosure), and mention use of GitHub's private vulnerability
reporting if enabled.
- Around line 5-6: Replace the placeholder template lines in SECURITY.md with a
concrete security policy: remove the GitHub instruction text and add the
supported release versions (e.g., list of maintained versions or branches), the
timeframe for security support per version, a clear vulnerability reporting
process (contact email or security form and expected response SLA), instructions
for submitting CVE/patches and disclosure policy, and any relevant links or
references; ensure the file contains no template wording and explicitly names
the versions covered and the contact/mechanism for reporting security issues.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
SECURITY.md
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.