Skip to content

docs(security): extend security policy #1142

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

Merged
merged 2 commits into from
May 14, 2025

Conversation

janderssonse
Copy link
Contributor

@janderssonse janderssonse commented May 11, 2025

Description

This PR adds a SECURITY.md file, battle tested in other projects and orgs, (the construct is CC0 ie public domain, for example from here https://raw.githubusercontent.com/itiquette/git-provider-sync/refs/heads/main/SECURITY.md so just reuse. I removed the (404)-link to the advisory, as that information is more aimed at a developer,maintainer, than a user of the project.

Motivation and Context

A SECURITY.md would help anyone assessing the project for use, give a hint of how it handles critical no public security issues, and give anyone a clear instruction on how to report them non public.

This policy basically says "send your findings, and we will see if we handle them, we will notify you".

NOTE: there is a <...> in the text, where the preferred channel for reporting should be added I left that for you, (or tell me what to add there, and I'll rebase with that.

Also, discussed in #1141

closes #1141

How Has This Been Tested?

In other projects, alike texts.

Screenshots / Logs (if 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 change)
  • Documentation (no code change)
  • Refactor (refactoring production code)
  • Other

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have formatted the code with rustfmt.
  • I checked the lints with clippy.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@janderssonse janderssonse requested a review from orhun as a code owner May 11, 2025 11:36
Copy link

welcome bot commented May 11, 2025

Thanks for opening this pull request! Please check out our contributing guidelines! ⛰️

@janderssonse janderssonse force-pushed the fix/add-security-policy branch from 449089d to e8cd58a Compare May 11, 2025 11:37
@codecov-commenter
Copy link

codecov-commenter commented May 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 40.04%. Comparing base (8c499c6) to head (d335ca0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1142      +/-   ##
==========================================
- Coverage   40.09%   40.04%   -0.05%     
==========================================
  Files          21       21              
  Lines        1911     1911              
==========================================
- Hits          766      765       -1     
- Misses       1145     1146       +1     
Flag Coverage Δ
unit-tests 40.04% <ø> (-0.05%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Owner

@orhun orhun left a comment

Choose a reason for hiding this comment

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

Thanks!

SECURITY.md Outdated
# Security Policy
# Security Reporting
Copy link
Owner

Choose a reason for hiding this comment

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

Should we maybe keep the old policy and add a new section as "Reporting" instead? I kinda find the previous page useful in terms of letting people know which versions of the project will support security updates.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agree 100%, and it is still in, look in the diff under "## Supported Versions"

Copy link
Contributor Author

@janderssonse janderssonse May 11, 2025

Choose a reason for hiding this comment

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

But let me know if it should be on top, right now it is the second heading.

Signed-off-by: Josef Andersson <janderssonse@proton.me>
@janderssonse janderssonse force-pushed the fix/add-security-policy branch from e8cd58a to 8d10404 Compare May 11, 2025 12:59
@janderssonse
Copy link
Contributor Author

janderssonse commented May 11, 2025

Thanks!

No, such a small contribution, but many thanks to you for git-cliff!! :) :)

Copy link
Owner

@orhun orhun left a comment

Choose a reason for hiding this comment

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

LGTM!

@orhun orhun merged commit 4c3c946 into orhun:main May 14, 2025
82 of 83 checks passed
Copy link

welcome bot commented May 14, 2025

Congrats on merging your first pull request! ⛰️

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.

Click on the link in SECURITY.md will give a 404
3 participants