max-mapper / max-mapper/extract-zip

Security.md WANTED

Open
#147 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
398
Forks
144
PR merge metrics
No merged PRs in 30d

Description

Hello @max-mapper ,
Thank you for your great work on extract-zip. It's a very useful library that many of us rely on.
I'm opening this issue to make a suggestion to improve the project's security posture. I noticed that the repository does not currently have a SECURITY.md file. This file is very helpful for defining a clear process for how security researchers should report vulnerabilities.
Suggestion:
Could you please consider adding a SECURITY.md file to the repository?
Benefits:
It provides clear, official guidelines for anyone who finds a security vulnerability.
It helps prevent security issues from being disclosed publicly in GitHub issues and promotes Responsible Disclosure.
GitHub will automatically display a link to your security policy on the "Security" tab and when someone creates a new issue.
Here is a simple template you could adapt. Using GitHub's private vulnerability reporting feature is often the easiest and most secure method.

Here is a simple template you could adapt. Using GitHub's private vulnerability reporting feature is often the easiest and most secure method.

# Security Policy

## Supported Versions

We are committed to providing security updates for the latest major version.

| Version | Supported          |
| ------- | ------------------ |
| 2.x.x   | :white_check_mark: |
| < 2.0   | :x:                |

## Reporting a Vulnerability

We take all security bugs in `extract-zip` seriously. We appreciate your help in disclosing them to us responsibly.

If you discover a security vulnerability, please report it to us by **using GitHub's private vulnerability reporting feature**. You can do this by going to the "Security" tab of our repository and clicking on "Report a vulnerability".

This will ensure that your finding is received and addressed by the maintainers privately. We will do our best to respond to your report within 48-72 hours.

**Please do not disclose security issues in public GitHub issues, discussions, or pull requests.**

FYI: I found a security risk on this library. I hope you make Security.md ASAP

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the proposed SECURITY.md template in the issue and the repository's existing documentation conventions. Add SECURITY.md with supported-version guidance and private vulnerability-reporting instructions; the work is done when the policy is present and directs researchers away from public issue reports.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, security
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.