-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add minimal SECURITY.md #51
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
⚙️ Control Options:
|
📝 WalkthroughWalkthroughThis PR adds a SECURITY.md file that defines the project's vulnerability disclosure process: a reporting email address, an optional PGP key URL for encrypted reports, and a link to the project's security policy. No code or public API declarations were changed. Possibly related PRs
Pre-merge checks❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: ASSERTIVE Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🪛 markdownlint-cli2 (0.18.1)SECURITY.md3-3: Bare URL used (MD034, no-bare-urls) ⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
🔇 Additional comments (1)
Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
SECURITY.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
SECURITY.md
3-3: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: check_release
🔇 Additional comments (2)
SECURITY.md (2)
3-3: Verify MD034 lint error.The static analysis flagged MD034 (no-bare-urls) on this line, but the URLs appear to be properly wrapped in markdown link syntax. Confirm whether this is a false positive from the linter or if there's a syntax issue.
1-5: Structure and content look good.The file is minimal and clear as intended. Remember to verify the PR's checklist items (email validity, link accessibility, and cross-repo consistency with other deepnote repositories).
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #51 +/- ##
=======================================
Coverage 69.56% 69.56%
=======================================
Files 13 13
Lines 253 253
Branches 28 28
=======================================
Hits 176 176
Misses 73 73
Partials 4 4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: Dino Hamzić <dino@subtlebits.com>
67d3a38
Add minimal SECURITY.md
Summary
Adds a minimal SECURITY.md file to the repository root with essential security contact information. The file provides the email address for reporting vulnerabilities, a link to the PGP key for encrypted communications, and references the canonical security policy at https://deepnote.com/.well-known/security.txt. This keeps SECURITY.md as a stable pointer to the authoritative policy, avoiding duplication of content that could become stale.
Review & Testing Checklist for Human
Notes
Link to Devin run: https://app.devin.ai/sessions/438185883eb74719998759b503cc47b5
Requested by: James Hobbs (james@deepnote.com) / @jamesbhobbs
Summary by CodeRabbit