|
| 1 | +# Security Policy |
| 2 | + |
| 3 | +## Reporting a Vulnerability |
| 4 | + |
| 5 | +We take security vulnerabilities seriously. If you believe you've discovered a security issue in js-beautify, please report it responsibly using GitHub's Private Vulnerability Reporting feature. |
| 6 | + |
| 7 | +### How to Report |
| 8 | + |
| 9 | +**DO NOT** open a public GitHub issue for security vulnerabilities. |
| 10 | + |
| 11 | +Instead, use the private reporting feature: |
| 12 | +1. Go to the [Security tab](../../security/advisories) |
| 13 | +2. Click "Report a vulnerability" |
| 14 | +3. Fill out the form with details of the vulnerability |
| 15 | +4. Submit your report |
| 16 | + |
| 17 | +This creates a private communication channel between you and the maintainers. |
| 18 | + |
| 19 | +### What to Include in Your Report |
| 20 | + |
| 21 | +Please provide: |
| 22 | +- Description of the vulnerability |
| 23 | +- Steps to reproduce (or proof-of-concept) |
| 24 | +- Affected versions |
| 25 | +- Suggested remediation (if you have one) |
| 26 | +- Your contact information (optional) |
| 27 | + |
| 28 | +### Response Timeline |
| 29 | + |
| 30 | +- **Initial Response**: Within 48 hours of submission |
| 31 | +- **Updates**: We'll keep you informed of progress toward a fix |
| 32 | +- **Disclosure Coordination**: We'll work with you on timing for public disclosure |
| 33 | + |
| 34 | +### Security Best Practices |
| 35 | + |
| 36 | +When using js-beautify: |
| 37 | +- Keep the package updated to the latest version |
| 38 | +- Validate and sanitize all input data before beautifying |
| 39 | +- Don't beautify untrusted code or markup in security-critical contexts |
| 40 | + |
| 41 | +## Security Advisories |
| 42 | + |
| 43 | +Once a vulnerability is patched: |
| 44 | +- We'll publish a security advisory on GitHub |
| 45 | +- Release notes will credit the researcher (unless requested otherwise) |
| 46 | +- Users will be notified via GitHub's security alerts |
| 47 | + |
| 48 | +## Questions? |
| 49 | + |
| 50 | +For questions about this policy, please open a regular (non-security) GitHub issue. |
| 51 | + |
| 52 | +--- |
| 53 | + |
| 54 | +Thank you for helping keep js-beautify secure! 🙏 |
0 commit comments