docs: make the SECURITY.md links clickable - #82
Conversation
The statement URL and the reporting address were bare text. Dave asked for the URL to be a real link on pgedge-safesession#73: GitHub autolinks it, but nothing guarantees another viewer will, and the two actionable things in a security policy should not depend on a renderer. The published statement at docs.pgedge.com/security already writes the address as an explicit mailto link, so this keeps the two documents consistent. coldfront#80 merged before that review landed, so this is the follow-up. Identical across every repo carrying this file.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe security policy now presents the vulnerability reporting email and security documentation URL as clickable Markdown links. ChangesSecurity documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This localized documentation change makes the security statement and reporting address clickable without changing security behavior; no actionable merge-blocking risk remains. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
Up to standards ✅🟢 Issues
|
2 participants
Follow-up to #80, which merged before Dave's review landed on
pgEdge/pgedge-safesession#73.That review asked for the statement URL to be a real link rather than bare text:
GitHub autolinks a bare URL, but nothing guarantees another viewer will, and the two actionable things in a security policy should not depend on a renderer. So both are now explicit Markdown links:
https://docs.pgedge.com/security— the disclosure statementsecurity@pgedge.com— the reporting address, now amailto:linkThe address was not part of Dave's comment, but it is the same defect, and the published statement at https://docs.pgedge.com/security already writes it as an explicit
mailto:link. This keeps the two documents consistent.The file stays byte-identical to the block in the approved template and to the copy going into every other pgEdge repo, so there is nothing coldfront-specific here.