Skip to content

Commit

Permalink
Add security.md file
Browse files Browse the repository at this point in the history
... containing information about how to report security issues and what versions of PHP_CodeSniffer are supported from a security point of view.

The file is placed in the `.github` directory. This will allow for it to be recognized correctly by GitHub, while not cluttering up the project root directory.

Ref: https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository
  • Loading branch information
jrfnl committed May 19, 2023
1 parent 2dc7b59 commit 24515af
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Security Policy

## Supported Versions

The latest patch version of the `3.x` release series is supported for security updates.

## Reporting a Vulnerability

PHP_CodeSniffer is a developer tool and should generally not be used in a production (web accessible) environment.

Having said that, responsible disclosure of security issues is highly appreciated.

**Please do not report or discuss security vulnerabilities through public GitHub issues, discussions, or pull requests.**

Issues can be reported privately to the maintainers by opening a [Security vulnerability report](https://github.com/squizlabs/PHP_CodeSniffer/security/advisories/new).

### Preferences

* Please provide detailed reports with reproducible steps and a clearly defined impact.
* Include the version number of the vulnerable package in your report.
* Fixes are most welcome.
A private PR can be created from the security report to work on and discuss the patch.

0 comments on commit 24515af

Please sign in to comment.