Skip to content

docs: add a way to report security issues - #258

Merged
mdevolde merged 1 commit into
jxmorris12:masterfrom
mdevolde:docs/security
Nov 1, 2026
Merged

mdevolde merged 1 commit into
jxmorris12:masterfrom
mdevolde:docs/security

Conversation

@mdevolde

@mdevolde mdevolde commented Nov 1, 2026

Copy link
Copy Markdown
Collaborator

docs: add a way to report security issues

Why the pull request was made

To add a second way to report security issues.

Summary of changes

Add the possibility to email a maintainer to report a security issue in the library.

Screenshots (if appropriate):

Not applicable.

How has this been tested?

Not applicable.

Resources

Not applicable.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (changes to documentation only)
  • Refactor / code style update (non-breaking change that improves code structure or readability)
  • Tests / CI improvement (adding or updating tests or CI configuration only)
  • Chore / maintenance (non-breaking change that does not affect functionality, such as updating dependencies or fixing typos)
  • Other (please describe):

Checklist

  • Followed the project's contributing guidelines.
  • Updated any relevant tests.
  • Updated any relevant documentation.
  • Added comments to your code where necessary.
  • Formatted your code, run the linters, checked types and tests.
  • Added your changes to the CHANGELOG file, if applicable.

@mdevolde
mdevolde requested a balanced review from Copilot November 1, 2026 10:00

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

Independent maintainer verification is needed because repository checks can confirm the documented fingerprint matches the key but cannot establish control of the security-reporting email account or PGP key.

No open issues 🎉

Review effort: Lite

@mdevolde mdevolde self-assigned this Nov 1, 2026
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (06359ac) to head (e4c2738).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #258   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           13        13           
  Lines         1743      1743           
=========================================
  Hits          1743      1743           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mdevolde
mdevolde merged commit 0cfc2e8 into jxmorris12:master Nov 1, 2026
13 checks passed
@mdevolde
mdevolde deleted the docs/security branch November 1, 2026 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants