Skip to content

Commit 11c7e4b

Browse files
committed
docs: add SECURITY.md
Add security policy to provide clear guidelines for reporting vulnerabilities and security best practices for contributors.
1 parent 791deb4 commit 11c7e4b

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

SECURITY.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
| ------- | ------------------ |
7+
| latest | :white_check_mark: |
8+
9+
## Reporting a Vulnerability
10+
11+
If you discover a security vulnerability in this project, please report it responsibly.
12+
13+
**Please do NOT open a public issue for security vulnerabilities.**
14+
15+
Instead, please send an email to the project maintainers or use GitHub's private vulnerability reporting feature.
16+
17+
### What to include
18+
19+
- A description of the vulnerability
20+
- Steps to reproduce the issue
21+
- Possible impact of the vulnerability
22+
- Any suggested fixes (if applicable)
23+
24+
### Response Timeline
25+
26+
- **Acknowledgment**: Within 48 hours
27+
- **Initial assessment**: Within 1 week
28+
- **Fix or mitigation**: Depends on severity, typically within 2-4 weeks
29+
30+
### After Reporting
31+
32+
- The security team will validate the vulnerability
33+
- We will work on a fix and coordinate disclosure
34+
- Credit will be given to the reporter (unless anonymity is requested)
35+
36+
## Security Best Practices for Contributors
37+
38+
- Keep dependencies up to date
39+
- Avoid committing sensitive information (API keys, passwords, tokens)
40+
- Follow secure coding practices
41+
- Review code changes for potential security implications

0 commit comments

Comments
 (0)