Create SECURITY.md #188
Create SECURITY.md #188
Conversation
WalkthroughAdds a new SECURITY.md with a security policy detailing supported versions and vulnerability reporting procedures. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
SECURITY.md (1)
1-3: Consider relocating to .github/SECURITY.md for GitHub’s native surfacing.GitHub also recognizes SECURITY.md at repo root, but placing it under .github/ helps standardize across repos.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
SECURITY.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
SECURITY.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...about which versions of your project are currently being supported with security ...
(QB_NEW_EN)
[grammar] ~8-~8: There might be a mistake here.
Context: ...dates. | Version | Supported | | ------- | ------------------ | | 5.1.x...
(QB_NEW_EN)
[grammar] ~9-~9: There might be a mistake here.
Context: ... | | ------- | ------------------ | | 5.1.x | ✅ | | 5.0.x...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...----- | | 5.1.x | ✅ | | 5.0.x | ❌ | | 4.0.x...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...mark: | | 5.0.x | ❌ | | 4.0.x | ✅ | | < 4.0...
(QB_NEW_EN)
[grammar] ~12-~12: There might be a mistake here.
Context: ... | | 4.0.x | ✅ | | < 4.0 | ❌ | ## Rep...
(QB_NEW_EN)
🔇 Additional comments (1)
SECURITY.md (1)
8-13: The script above will list all tags in the repository so we can verify if semver tags exist. Please share the output to determine the correct values for the Supported Versions table.
| Use this section to tell people about which versions of your project are | ||
| currently being supported with security updates. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Replace placeholder guidance with a clear policy statement.
Current wording reads like a template. Make it explicit which releases get fixes.
-Use this section to tell people about which versions of your project are
-currently being supported with security updates.
+We provide security fixes only for the release lines listed below. Versions not listed are end‑of‑life and do not receive security updates.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Use this section to tell people about which versions of your project are | |
| currently being supported with security updates. | |
| We provide security fixes only for the release lines listed below. Versions not listed are end-of-life and do not receive security updates. |
🧰 Tools
🪛 LanguageTool
[grammar] ~5-~5: There might be a mistake here.
Context: ...about which versions of your project are currently being supported with security ...
(QB_NEW_EN)
🤖 Prompt for AI Agents
In SECURITY.md around lines 5 to 7, the current text is a placeholder template;
replace it with a concrete security maintenance policy specifying which release
lines receive security fixes (e.g., "We provide security fixes for the current
major release and the previous minor release for 12 months after their initial
release; critical/severe issues may receive extended support"), include how long
fixes are provided, which versions are supported (exact semantic versions or
branches), and where to report vulnerabilities; update the wording to a
definitive, actionable statement rather than a template sentence.
| ## Reporting a Vulnerability | ||
|
|
||
| Use this section to tell people how to report a vulnerability. | ||
|
|
||
| Tell them where to go, how often they can expect to get an update on a | ||
| reported vulnerability, what to expect if the vulnerability is accepted or | ||
| declined, etc. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Provide concrete, private reporting instructions, SLAs, and safe‑harbor.
Reporting guidance is still template text. Add a private channel (GitHub security advisory and/or email), acknowledgement/fix timelines, what info to include, disclosure policy, and legal safe‑harbor. This materially improves researcher experience.
-## Reporting a Vulnerability
-
-Use this section to tell people how to report a vulnerability.
-
-Tell them where to go, how often they can expect to get an update on a
-reported vulnerability, what to expect if the vulnerability is accepted or
-declined, etc.
+## Reporting a Vulnerability
+
+Please do not open public issues for security reports.
+
+- Preferred: Open a private GitHub Security Advisory for this repository (Security → Advisories → Report a vulnerability).
+- Alternative: Email security@<your-domain> (PGP optional; see key below).
+
+We will:
+- Acknowledge receipt within 3 business days.
+- Provide an initial assessment or remediation ETA within 7 business days.
+- Credit reporters upon request after a fix is released.
+
+Please include: affected versions/commit, impact, reproduction steps or PoC, environment, and proposed severity (CVSS if available).
+
+## Coordinated Disclosure
+We ask for coordinated disclosure. We will agree on a public disclosure date once a fix or mitigation is available. Please avoid testing that could disrupt production or access data you do not own.
+
+## Safe Harbor
+We will not pursue legal action for good‑faith research that follows this policy and avoids privacy violations, data exfiltration, or service degradation. If you are unsure, contact us first.
+
+## Optional: PGP Key
+Fingerprint: <fill‑in>
+Key: <URL or block>If you prefer lighter wording, I can trim this to a shorter policy.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Reporting a Vulnerability | |
| Use this section to tell people how to report a vulnerability. | |
| Tell them where to go, how often they can expect to get an update on a | |
| reported vulnerability, what to expect if the vulnerability is accepted or | |
| declined, etc. | |
| ## Reporting a Vulnerability | |
| Please do not open public issues for security reports. | |
| - Preferred: Open a private GitHub Security Advisory for this repository (Security → Advisories → Report a vulnerability). | |
| - Alternative: Email security@<your-domain> (PGP optional; see key below). | |
| We will: | |
| - Acknowledge receipt within 3 business days. | |
| - Provide an initial assessment or remediation ETA within 7 business days. | |
| - Credit reporters upon request after a fix is released. | |
| Please include: affected versions/commit, impact, reproduction steps or PoC, environment, and proposed severity (CVSS if available). | |
| ## Coordinated Disclosure | |
| We ask for coordinated disclosure. We will agree on a public disclosure date once a fix or mitigation is available. Please avoid testing that could disrupt production or access data you do not own. | |
| ## Safe Harbor | |
| We will not pursue legal action for good-faith research that follows this policy and avoids privacy violations, data exfiltration, or service degradation. If you are unsure, contact us first. | |
| ## Optional: PGP Key | |
| Fingerprint: <fill-in> | |
| Key: <URL or block> |
Summary by CodeRabbit