Skip to content
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

docs: create security policy #4394

Merged
merged 6 commits into from
Oct 8, 2021
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Security Policy
## Supported Versions
Legacy-compatibility releases `v1.x`:
- :hourglass_flowing_sand: Web3.js currently undergoes a quick release cycle with regular minor and patch releases.
- :globe_with_meridians: We encourage using the [most recently released version](https://github.com/ChainSafe/web3.js/releases/latest) from the `v1.x` release track before reporting an issue.

Future rewrites and feature tracks `v2.x`, `v3.x`, and `v4.x`:
- :hourglass: Web3.js currently undergoes a complete refactoring and rewrite. At this time it is not recommended to use any of these release tracks, yet.
q9f marked this conversation as resolved.
Show resolved Hide resolved
- :stop_sign: We encourage **not** using these releases until official stable releases will be announced.

## Reporting a Vulnerability
- :rotating_light: Please, send vulnerability reports to `[email protected]`.
- :warning: **Please do not file a public ticket** mentioning the vulnerability, as doing so could increase the likelihood of the vulnerability being exploited before a fix has been created, released and installed on the network.