Skip to content

Commit 262ee11

Browse files
SECURITY.md (#169)
* SECURITY.md * Update SECURITY.md
1 parent 790c7bf commit 262ee11

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

β€ŽSECURITY.mdβ€Ž

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# πŸ”’ Security Polspliticy
2+
3+
Thank you for your interest in keeping the `splitwiser` project secure. This document explains how to report security vulnerabilities, what to expect after reporting, and how we handle disclosures.
4+
5+
---
6+
7+
## πŸ›‘οΈ Reporting a Vulnerability
8+
9+
If you discover a security vulnerability, **please do not open an issue** on GitHub.
10+
11+
Instead, follow these steps:
12+
13+
1. **Email the maintainer directly**
14+
2. Include the following details:
15+
- Description of the vulnerability
16+
- Steps to reproduce (if possible)
17+
- Potential impact
18+
- Any mitigation or workaround suggestions
19+
20+
---
21+
22+
## 🚫 Responsible Disclosure Guidelines
23+
24+
We ask that you:
25+
- Do not publicly disclose the issue until it has been resolved.
26+
- Avoid testing vulnerabilities in a way that could disrupt services.
27+
- Act in good faith and with respect for user data and privacy.
28+
29+
---
30+
31+
## πŸ“ƒ Disclosure Policy
32+
33+
- We follow a **coordinated disclosure** approach.
34+
- We appreciate responsible reporting and will publicly disclose the issue only **after a fix has been released**.
35+
---
36+
37+
## πŸ”„ Security Fixes & Releases
38+
39+
Security fixes will be merged into `main` and any supported release branches. We will publish release notes describing the fix and migration steps when required.
40+
41+
---
42+
43+
## πŸ™ Acknowledgments
44+
45+
We value the contributions from the community and encourage responsible disclosure to help keep `splitwiser` safe and secure for all users.
46+
47+
---
48+
49+
## πŸ”’ Resources
50+
51+
- [GitHub Security Advisories](https://docs.github.com/en/code-security/security-advisories)
52+
- [OpenSSF Best Practices](https://bestpractices.dev/)
53+
- [OWASP Top 10](https://owasp.org/www-project-top-ten/)

0 commit comments

Comments
Β (0)