Skip to content

Commit 3db8e03

Browse files
docs: create SECURITY.md
1 parent 6a3a5bf commit 3db8e03

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

SECURITY.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Security Policy for Chess-TUI
2+
3+
Thank you for using and contributing to **Chess-TUI**! Security is important to us. This document explains how you can report security vulnerabilities and what to expect after reporting.
4+
5+
## Supported Versions
6+
7+
We provide security updates for the following versions of Chess-TUI:
8+
9+
| Version | Supported |
10+
| ------------- | :-------: |
11+
| Latest ||
12+
| Older stable ||
13+
14+
*We recommend always running the latest release to ensure you have the most recent security fixes.*
15+
16+
## Reporting a Vulnerability
17+
18+
If you discover a security vulnerability in Chess-TUI, **please do NOT open a public GitHub issue**. Public issues may expose technical details before a fix is available.
19+
20+
### How to Report
21+
22+
You can report security issues in one of the following ways:
23+
24+
1. **GitHub Security Advisory**
25+
Use the “Security” → “Advisories” section of this repository to submit a private security report.
26+
27+
2. **Email**
28+
Send a detailed report to:
29+
`thomasmauran@yahoo.com`
30+
31+
Please include in your report:
32+
- A clear description of the vulnerability
33+
- Steps to reproduce or a proof-of-concept
34+
- Affected version(s)
35+
- Any relevant logs or screenshots
36+
37+
## Response Timeline
38+
39+
We aim to acknowledge all reports within **72 hours**. After verification, we will:
40+
- Coordinate with the reporter on disclosure details
41+
- Prepare and release a fix
42+
- Update this policy if needed
43+
44+
We will work with you on disclosure timing so that fixes can be published before public details.
45+
46+
## Responsible Disclosure
47+
48+
By reporting issues through the channels above, you agree to:
49+
- Not publicly disclose the vulnerability before a fix is published
50+
- Cooperate with maintainers to validate and patch the issue
51+
52+
## After a Fix is Released
53+
54+
Once a security fix is ready:
55+
- We will publish release notes for the fixed version
56+
- We encourage users to update promptly
57+
- Credit for discoverers may be given, unless anonymity was requested
58+
59+
## Additional Resources
60+
61+
For general guidance on creating repository security policies, see GitHub’s documentation on repository security policies and reporting vulnerabilities.

0 commit comments

Comments
 (0)