Conversation
tarinagarwal
left a comment
There was a problem hiding this comment.
Thanks for starting this! A few things to fix:
-
Rename file to
SECURITY.md(uppercase, GitHub convention) -
Wrong email - Use
tarinagarwal@gmail.cominstead ofedulume@gmail.com -
Markdown formatting - Headers need
#prefix:# Security Policy## Supported Versions## Reporting a Vulnerability- etc.
-
Version table needs proper markdown table syntax
-
Missing content from issue #105:
- Response timeline (e.g. "We aim to respond within 48 hours")
- Scope of security concerns (auth, API, document storage, etc.)
- Responsible disclosure guidelines
-
PR template - Fill in the description and update
Closes #toCloses #105
tarinagarwal
left a comment
There was a problem hiding this comment.
Getting closer! A few more fixes:
-
Rename file to SECURITY.md (uppercase)
-
Duplicate section - 'Supported Versions' appears twice at the top, remove one
-
Inconsistent headers - Use ## for all main sections (not # for some)
-
Version table - Format as proper markdown table:
\
| Version | Supported |
|---------|-----------|
| 1.x.x | Yes |
| 0.x.x | No |
\\ -
Add newline at end of file
tarinagarwal
left a comment
There was a problem hiding this comment.
Almost there! Final fixes needed - please address ALL of these:
-
RENAME FILE from Security.md to SECURITY.md (UPPERCASE - this is GitHub's standard)
-
Fix headers - Change # Security Best Practices and # Acknowledgements to ## Security Best Practices and ## Acknowledgements (use ## not #)
-
Fix table - Should be:
| Version | Supported | |---------|-----------| | 1.x.x | Yes | | 0.x.x | No | -
Add newline at end of file
This is the 3rd review - please fix ALL issues in one go so we can merge.
|
Please merge the pr |
There was a problem hiding this comment.
Looks Good To Meow 🐱
Hey @! Nice work on this one. This PR adds a comprehensive Security.md documentation file outlining the project's security policy, reporting procedures, and best practices. The documentation is well-structured with no code changes, but includes a direct email contact which may pose spam risks. Reviewers recommend referencing this new document in main project docs for better discoverability.
I left a few minor suggestions below — nothing blocking, just things to consider.
Note: This is an AI-generated approval. A maintainer will follow up with the final human review shortly.
Nice-to-haves
- Replace direct email address with a safer contact method to reduce spam risk.
- Update main README or contributing documentation to reference the new Security.md file for better visibility.
- Ensure consistent formatting and avoid hardcoded contact details for maintainability.
Findings breakdown (6 total)
1 medium / 1 low / 4 info
Confidence: 90%
🔗 View Full Review Report — detailed findings, severity breakdown, and agent analysis
Reviewed by Looks Good To Meow — AI-powered code review
💬 You can interact with me directly in this PR:
@tarin-lgtm fix [any constraints]@tarin-lgtm explain [your question]@tarin-lgtm improve [focus area]@tarin-lgtm test [what to focus on]
|
|
||
| ## How to Report | ||
|
|
||
| Please report vulnerabilities by emailing us at tarinagarwal@gmail.com. Include as much detail as possible to help us identify and fix the issue swiftly. |
There was a problem hiding this comment.
🔍 Medium — The security policy includes an email address for reporting vulnerabilities. Publishing direct email addresses in public repos can lead to spam and phishing risks.
Consider using a dedicated security contact form or a security-specific email alias with spam filtering to handle vulnerability reports securely.
best-practices
|
|
||
| ## How to Report | ||
|
|
||
| Please report vulnerabilities by emailing us at tarinagarwal@gmail.com. Include as much detail as possible to help us identify and fix the issue swiftly. |
There was a problem hiding this comment.
💡 Suggestion — The email address 'tarinagarwal@gmail.com' is hardcoded in the security policy. Hardcoding contact information can make updates harder and may cause inconsistencies if used elsewhere.
Consider defining the contact email as a named constant or referencing a centralized contact info file to improve maintainability.
readability
📝 Description
🔗 Related Issue
Issue No: #105
Closes #105
🏷️ Type of Change
📸 Screenshots (if applicable)
✅ Checklist
🧪 Testing
📋 Additional Notes
SWOC 2026 Participant? Add
swoc2026label to your PR! 🎉