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 |
📝 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! 🎉