docs: add SECURITY.md with disclosure policy#151
Open
mrbrandao wants to merge 2 commits into
Open
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis PR adds a repository security policy by introducing ChangesSecurity Policy Implementation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/dev-guide/contributing.md (1)
5-5: ⚡ Quick winUse a repo-relative
SECURITY.mdlink instead ofblob/main.Line 5 hardcodes
main, which can drift for forks/releases and branch previews. Prefer a relative link so docs stay context-correct.Suggested doc fix
-For security vulnerabilities, see [SECURITY.md](https://github.com/LobsterTrap/lola/blob/main/SECURITY.md). +For security vulnerabilities, see [SECURITY.md](../../SECURITY.md).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/dev-guide/contributing.md` at line 5, Replace the hardcoded GitHub blob/main URL in the contributing doc's security link—specifically the line that reads "For security vulnerabilities, see [SECURITY.md](https://github.com/.../blob/main/SECURITY.md)"—with a repo-relative link like "[SECURITY.md](../SECURITY.md)" or simply "[SECURITY.md](SECURITY.md)" so the link resolves correctly in forks, branch previews, and releases.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@SECURITY.md`:
- Around line 20-23: Remove the public "GitHub Discussions" contact suggestion
in SECURITY.md (the line linking to
https://github.com/LobsterTrap/lola/discussions and the phrase "GitHub
Discussions") and replace it with a private reporting option: either reference
the previously described private channel in this file (e.g., the email or secure
intake described above) or point reporters to GitHub's private Security
Advisories/SECURITY_EMAIL; update the sentence to instruct reporters to use a
private channel instead of Discussions and ensure the link and text no longer
suggest public discussion for vulnerability reports.
---
Nitpick comments:
In `@docs/dev-guide/contributing.md`:
- Line 5: Replace the hardcoded GitHub blob/main URL in the contributing doc's
security link—specifically the line that reads "For security vulnerabilities,
see [SECURITY.md](https://github.com/.../blob/main/SECURITY.md)"—with a
repo-relative link like "[SECURITY.md](../SECURITY.md)" or simply
"[SECURITY.md](SECURITY.md)" so the link resolves correctly in forks, branch
previews, and releases.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c8cfaeab-1430-469b-80c0-1a69e91d233f
📒 Files selected for processing (3)
README.mdSECURITY.mddocs/dev-guide/contributing.md
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
1 participant
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
SECURITY.mdwith supported versions, vulnerability reporting process (GitHub private advisories), coordinated disclosure policy, security best practices, and scope definitionSECURITY.mdfromREADME.md(before Contributing section to avoid conflicts with governance PR) anddocs/dev-guide/contributing.mdRelated Issues
Part of AAIF readiness work. Required for OpenSSF Best Practices Badge application.
Test Plan
Checklist
pytest)ruff check src tests)ty check)AI Disclosure
AI-assisted with Claude Code
Summary by CodeRabbit