Skip to content

Create SECURITY.md for security policy#3

Merged
martian56 merged 1 commit into
mainfrom
security-policy
Mar 7, 2026
Merged

Create SECURITY.md for security policy#3
martian56 merged 1 commit into
mainfrom
security-policy

Conversation

@martian56
Copy link
Copy Markdown
Member

Add a security policy document outlining supported versions and vulnerability reporting.

Add a security policy document outlining supported versions and vulnerability reporting.
@martian56 martian56 self-assigned this Mar 7, 2026
Copilot AI review requested due to automatic review settings March 7, 2026 12:51
@martian56 martian56 added the documentation Improvements or additions to documentation label Mar 7, 2026
@martian56 martian56 merged commit 585991f into main Mar 7, 2026
3 checks passed
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a SECURITY.md document to define the project’s security policy (supported versions and vulnerability reporting process).

Changes:

  • Introduces SECURITY.md with sections for supported versions and vulnerability reporting.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread SECURITY.md
Comment on lines +5 to +14
Use this section to tell people about which versions of your project are
currently being supported with security updates.

| Version | Supported |
| ------- | ------------------ |
| 5.1.x | :white_check_mark: |
| 5.0.x | :x: |
| 4.0.x | :white_check_mark: |
| < 4.0 | :x: |

Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

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

The “Supported Versions” section still contains GitHub template placeholder text and a generic version support table (e.g., 5.1.x/5.0.x) that doesn’t appear to match this repo’s actual versioning/release scheme. Please replace this with project-specific supported version(s) (or state that only the latest release/main branch is supported) and remove the placeholder guidance text.

Suggested change
Use this section to tell people about which versions of your project are
currently being supported with security updates.
| Version | Supported |
| ------- | ------------------ |
| 5.1.x | :white_check_mark: |
| 5.0.x | :x: |
| 4.0.x | :white_check_mark: |
| < 4.0 | :x: |
This project currently supports only the latest version on the `main` branch for security updates.
All older releases and branches are not supported and will not receive security fixes.

Copilot uses AI. Check for mistakes.
Comment thread SECURITY.md
Comment on lines +17 to +21
Use this section to tell people how to report a vulnerability.

Tell them where to go, how often they can expect to get an update on a
reported vulnerability, what to expect if the vulnerability is accepted or
declined, etc.
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

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

The “Reporting a Vulnerability” section is still template text and doesn’t provide an actionable reporting channel. Please specify where to report (e.g., GitHub Security Advisories / private email), what information to include, and expected response timelines so reporters know how to proceed.

Suggested change
Use this section to tell people how to report a vulnerability.
Tell them where to go, how often they can expect to get an update on a
reported vulnerability, what to expect if the vulnerability is accepted or
declined, etc.
If you believe you have found a security vulnerability in this project, please
report it privately via a GitHub Security Advisory:
1. Go to the repository page on GitHub.
2. Click on the **Security** tab.
3. Click **Report a vulnerability** and follow the instructions.
When submitting a report, please include as much of the following information
as possible to help us triage and remediate the issue quickly:
- A clear description of the vulnerability and its impact.
- The affected version(s) (see the table above) and any specific configuration
required to reproduce it.
- Step‑by‑step reproduction instructions and, if possible, a minimal proof of
concept (PoC).
- Any logs, stack traces, or screenshots that may be helpful.
- Your assessment of the severity (for example, based on CVSS) if you have one.
**Response and disclosure process**
- We aim to acknowledge receipt of your report within **3 business days**.
- We will provide updates at least every **7 days** while the issue is being
investigated and fixed.
- Once a fix is ready, we will work with you on coordinated disclosure timing.
- Credit will be given in release notes or advisories if you wish, unless you
request to remain anonymous.

Copilot uses AI. Check for mistakes.
@martian56 martian56 deleted the security-policy branch May 2, 2026 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants