-
-
Notifications
You must be signed in to change notification settings - Fork 99
feat: add issue templates, security policy, and update contributing guide #299
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| name: Bug Report | ||
| about: Report a bug or unexpected behavior | ||
| title: "fix: " | ||
| labels: "bug" | ||
| assignees: "" | ||
| --- | ||
|
|
||
| ## Summary | ||
| <!-- Brief description of the bug --> | ||
|
|
||
| ## Reproduction | ||
| <!-- Steps to reproduce the behavior --> | ||
| 1. | ||
| 2. | ||
| 3. | ||
|
|
||
| ## Expected Behavior | ||
| <!-- What you expected to happen --> | ||
|
|
||
| ## Actual Behavior | ||
| <!-- What actually happened --> | ||
|
|
||
| ## Environment | ||
| - **Node.js version**: | ||
| - **OS**: | ||
| - **filesize.js version**: | ||
|
|
||
| ## Code Sample | ||
| <!-- Minimal code snippet that reproduces the issue --> | ||
|
|
||
| ```javascript | ||
| // Your code here | ||
| ``` | ||
|
|
||
| ## Additional Context | ||
| <!-- Any other context, screenshots, or logs --> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| name: Feature Request | ||
| about: Suggest a new feature or enhancement | ||
| title: "feat: " | ||
| labels: "enhancement" | ||
| assignees: "" | ||
| --- | ||
|
|
||
| ## Summary | ||
| <!-- Brief description of the proposed feature --> | ||
|
|
||
| ## Motivation | ||
| <!-- Why is this feature needed? What problem does it solve? --> | ||
|
|
||
| ## Proposed Solution | ||
| <!-- How would you implement this? What would the API look like? --> | ||
|
|
||
| ## Example Usage | ||
| <!-- Code example showing how this feature would be used --> | ||
|
|
||
| ```javascript | ||
| // Your code here | ||
| ``` | ||
|
|
||
| ## Alternatives Considered | ||
| <!-- Any alternative approaches you've considered --> | ||
|
|
||
| ## Additional Context | ||
| <!-- Any other context, screenshots, or references --> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,3 +25,8 @@ | |
| - [ ] No hardcoded secrets or credentials introduced | ||
| - [ ] Zero external dependencies added | ||
| - [ ] ES Modules only (no CommonJS in src/) | ||
| - [ ] JSDoc comments added/updated | ||
| - [ ] CHANGELOG.md updated (if applicable) | ||
|
|
||
| ## Screenshots (if applicable) | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This adds a new Severity: low 🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage. |
||
| <!-- Add screenshots or GIFs for UI changes --> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| # Security Policy | ||
|
|
||
| ## Supported Versions | ||
|
|
||
| Only the latest major version receives security updates. | ||
|
|
||
| | Version | Supported | | ||
| | ------- | ------------------ | | ||
| | 6.x | :white_check_mark: | | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| | < 6.0 | :x: | | ||
|
|
||
| ## Reporting a Vulnerability | ||
|
|
||
| We take security seriously. If you discover a security vulnerability, please report it responsibly. | ||
|
|
||
| ### How to Report | ||
|
|
||
| 1. **Do not** open a public issue | ||
| 2. Email security findings to the maintainers | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The reporting instructions say to "Email security findings to the maintainers" but don't provide a security contact address or an alternative private channel, which makes the policy hard to follow in practice. Severity: medium 🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage. |
||
| 3. Include: | ||
| - Description of the vulnerability | ||
| - Steps to reproduce | ||
| - Potential impact | ||
| - Suggested fix (if any) | ||
|
|
||
| ### What to Expect | ||
|
|
||
| - **Acknowledgment**: Within 48 hours | ||
| - **Assessment**: Within 1 week | ||
| - **Fix timeline**: Depends on severity | ||
| - Critical: Immediate patch | ||
| - High: Within 30 days | ||
| - Medium/Low: Next release cycle | ||
|
|
||
| ### Scope | ||
|
|
||
| This policy covers: | ||
| - Code execution vulnerabilities | ||
| - Data corruption or loss | ||
| - Authentication/authorization bypass | ||
| - Prototype pollution | ||
| - Dependency vulnerabilities affecting the core | ||
|
|
||
| ### Safe Harbors | ||
|
|
||
| We will not take legal action against security researchers who: | ||
| - Follow this responsible disclosure process | ||
| - Make reasonable efforts to privacy and data protection | ||
| - Keep vulnerabilities confidential until patched | ||
|
|
||
| ## Security Best Practices | ||
|
|
||
| When using filesize.js: | ||
| - Always validate input data before passing to filesize() | ||
| - Keep dependencies updated | ||
| - Use the latest stable version | ||
| - Review changelog for security-related updates | ||
|
|
||
| ## Known Issues | ||
|
|
||
| No known security issues at this time. | ||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The environment prompt asks for a "filesize.js version"; since the published package name is
filesize, reporters might provide the wrong identifier/version here.Severity: low
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.