Skip to content

Create SECURITY.md for security policy #49

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.

Sign up for GitHub

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

Open
Sawsqr68 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create SECURITY.md for security policy #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Security Policy

## Supported Versions

Use this section to tell people about which versions of your project are
currently being supported with security updates.

Comment on lines +5 to +7

Copilot AI Dec 7, 2025

Copy link

Choose a reason for hiding this comment

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

The placeholder instructional text should be replaced with actual information about the project's versioning and support policy. This template text does not provide meaningful guidance to users.

Suggested change
Use this section to tell people about which versions of your project are
currently being supported with security updates.
The following table lists the versions of this project that are currently supported with security updates. Only the latest release in each major version is supported; older versions will not receive security updates.

Copilot uses AI. Check for mistakes.
| Version | Supported |
| ------- | ------------------ |
| 5.1.x | :white_check_mark: |
| 5.0.x | :x: |
| 4.0.x | :white_check_mark: |
| < 4.0 | :x: |

## Reporting a Vulnerability

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.
Comment on lines +17 to +21

Copilot AI Dec 7, 2025

Copy link

Choose a reason for hiding this comment

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

The placeholder instructional text should be replaced with specific vulnerability reporting instructions, including contact information (such as a security email address or reporting form), expected response times, and the process for handling reported vulnerabilities.

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.
To report a security vulnerability, please email our security team at [security@example.com](mailto:security@example.com). If you prefer, you may also use our secure reporting form at [https://example.com/security-report](https://example.com/security-report).
- **Acknowledgment:** We will acknowledge receipt of your report within 2 business days.
- **Investigation:** Our team will investigate the issue and may contact you for further information.
- **Updates:** You can expect updates on the status of your report at least every 7 days until the issue is resolved or a decision is made.
- **Resolution:** Once the vulnerability is confirmed, we will work to resolve it as quickly as possible and will notify you when the fix is released. If the vulnerability is declined, we will provide a clear explanation.
Please do not disclose the vulnerability publicly until we have had a chance to address it. If you require encrypted communication, please request our PGP key in your initial email.

Copilot uses AI. Check for mistakes.