If you discover a security vulnerability in this project, please report it responsibly. Do NOT publicly disclose security vulnerabilities.
-
GitHub Security Advisories (Recommended)
- Navigate to the "Security" tab of this repository
- Click "Report a vulnerability"
- Fill out the vulnerability report form
-
Email
- Contact the maintainers via email
- Include a detailed description of the vulnerability
- Provide steps to reproduce if possible
When reporting a vulnerability, please include:
- Description of the vulnerability
- Steps to reproduce the issue
- Potential impact assessment
- Any suggested fixes (if you have them)
- Your contact information for follow-up
This project implements several security measures:
- Gitleaks: Secret scanning in pre-commit hooks and CI/CD
- Dependabot: Automated dependency vulnerability updates
- Dependency Review: Supply chain security analysis on pull requests
- GitHub Actions: Workflow security with minimal permissions
- Pre-commit Hooks: Automated security checks before commits
- Conventional Commits: Enforced commit message format
- Branch Protection: Required reviews and status checks on main branch
- Vulnerability Assessment: We assess reported vulnerabilities within 48 hours
- Fix Development: Critical vulnerabilities are prioritized immediately
- Testing: All security fixes are thoroughly tested
- Release: Security updates are released as patch versions
- Disclosure: Public disclosure occurs after fix is released
We ask security researchers to:
- Give us reasonable time to respond and fix vulnerabilities before public disclosure
- Avoid privacy violations, data destruction, or service disruption
- Avoid accessing or modifying other users' data
- Act in good faith to avoid violating privacy and disrupting our services
As a template repository, we recommend always using the latest version. Security updates are applied to the main branch.
| Version | Supported |
|---|---|
| Latest | ✅ |
| Older | ❌ |
When using this template:
- Install pre-commit hooks: Run
pre-commit installimmediately - Review and customize: Adjust
.gitleaks.tomlallowlists for your project - Enable branch protection: Configure GitHub branch protection rules
- Update dependencies: Keep dependencies up-to-date with Dependabot
- Rotate secrets: Never commit secrets; rotate if accidentally exposed
- Use signed commits: Enable GPG signing for commits
For security-related questions or concerns, please contact the repository maintainers.
We appreciate the security research community's efforts to responsibly disclose vulnerabilities and keep open source projects secure.