Skip to content

Commit 600f232

Browse files
authored
docs: Create SECURITY.md (#140)
1 parent 2e89fa2 commit 600f232

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

SECURITY.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We actively provide security updates for the following versions of DevImpact:
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| Main | ✅ Yes |
10+
| < 1.0.0 | ❌ No |
11+
12+
## Reporting a Vulnerability
13+
14+
We take the security of DevImpact seriously. If you discover a security vulnerability, please do not open a public issue. Instead, follow the steps below:
15+
16+
### How to report
17+
1. **Email:** Please send a detailed report to osama.f.mabkhot@gmail.com or use GitHub's Private Vulnerability Reporting.
18+
2. **Details:** Include a description of the vulnerability, steps to reproduce, and the potential impact.
19+
3. **Response:** You can expect an acknowledgment within 48 hours.
20+
21+
### Scope
22+
This policy covers the core DevImpact application, its scoring logic, and how it handles the `GITHUB_TOKEN`. It does not cover the GitHub API itself or third-party dependencies (though we appreciate reports regarding how we use them).
23+
24+
## Best Practices for Contributors
25+
To keep this project secure, please keep the following in mind:
26+
* **Environment Variables:** Never commit your `.env` file. It contains your `GITHUB_TOKEN`.
27+
* **Data Sanitization:** Ensure all data fetched from the GitHub GraphQL API is sanitized before being rendered in the UI to prevent XSS.
28+
* **Dependency Updates:** We use automated tools to keep our dependencies up to date. Please ensure your PRs do not introduce insecure or outdated packages.
29+
30+
## Security Controls
31+
* **Code Scanning:** We use GitHub Actions to run automated security scans on every Pull Request.
32+
* **Secret Scanning:** GitHub's secret scanning is enabled to prevent the accidental leak of tokens.
33+
34+
---
35+
*Thank you for helping keep DevImpact safe for the open-source community!*

0 commit comments

Comments
 (0)