docs(security): update security policy with reporting guidelines and hints to supported versions#76
Conversation
Dependabot couldn't find the original pull request head commit, ea510f4. Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…immory-tools#2) Dependabot couldn't find the original pull request head commit, faed6bf. Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…mory-tools#3) Dependabot couldn't find the original pull request head commit, f110823. Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…hints to supported versions
📝 WalkthroughWalkthroughThe SECURITY.md file was restructured to formalize vulnerability reporting procedures, including two submission channels, a required information checklist, and a documented resolution process. The supported versions policy was updated to restrict security patches to the latest version only, and security best practices for deployment were added. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@SECURITY.md`:
- Around line 55-56: Update the note paragraph following the Markdown block
reference "[!NOTE]" so the first word is capitalized (change "this list is not
exhaustive." to "This list is not exhaustive."). Locate the "[!NOTE]" block in
SECURITY.md and edit the sentence that follows to start with a capital letter to
improve professionalism.
- Line 3: The "How to Report" heading currently uses an H3 (### How to Report)
which creates a jump from the H1; update the heading to H2 by changing "### How
to Report" to "## How to Report" so the document maintains proper heading
hierarchy and satisfies linters referencing the "How to Report" heading.
- Around line 12-14: The "Direct contact" section is ambiguous and may lead
reporters to share sensitive details publicly; update the SECURITY.md "Direct
contact" section to specify a single private reporting channel (for example a
dedicated security email address or a Discord DM to a named maintainer account),
provide exact contact details and clear instructions not to post vulnerability
details in public channels, and replace vague phrasing like "anybody with
'maintainer' role discord" with the chosen private channel and explicit note
about encryption or PGP for sensitive attachments; ensure the section header
"Direct contact" and its bullet text are changed accordingly.
| > [!NOTE] | ||
| > this list is not exhaustive. Always follow general security best practices when deploying any software. |
There was a problem hiding this comment.
Polish note capitalization for professionalism.
Capitalize the first word in the note text.
Suggested diff
> [!NOTE]
-> this list is not exhaustive. Always follow general security best practices when deploying any software.
+> This list is not exhaustive. Always follow general security best practices when deploying any software.📝 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.
| > [!NOTE] | |
| > this list is not exhaustive. Always follow general security best practices when deploying any software. | |
| > [!NOTE] | |
| > This list is not exhaustive. Always follow general security best practices when deploying any software. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@SECURITY.md` around lines 55 - 56, Update the note paragraph following the
Markdown block reference "[!NOTE]" so the first word is capitalized (change
"this list is not exhaustive." to "This list is not exhaustive."). Locate the
"[!NOTE]" block in SECURITY.md and edit the sentence that follows to start with
a capital letter to improve professionalism.
89113d4 to
37ca101
Compare
📝 Description
See: https://github.com/balazs-szucs/grimmory/blob/security-md-stuff/SECURITY.md
Linked Issue: Fixes #
🏷️ Type of Change
🔧 Changes
🧪 Testing (MANDATORY)
Manual testing steps you performed:
Regression testing:
Edge cases covered:
Test output:
Backend test output (
./gradlew test)Frontend test output (
ng test)📸 Screen Recording / Screenshots (MANDATORY)
✅ Pre-Submission Checklist
develop(merge conflicts resolved)🤖 AI-Assisted Contributions
TODOs, or unused scaffolding left behind by AI💬 Additional Context (optional)
Summary by CodeRabbit