Improve SECURITY.md (#3277)

* Improve SECURITY.md

* Update SECURITY.md

* Update SECURITY.md
This commit is contained in:
Shubh Sharma 2023-06-01 21:41:37 +05:30 committed by GitHub
parent b9990e8410
commit 40514a91d9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -2,11 +2,23 @@
## Reporting a Vulnerability
To report a security vulnerability, please email the maintainers at `maintainers@yew.rs`. Please do not create a Github issue
for security vulnerabilities.
Please do not create a GitHub issue for security vulnerabilities, Instead do the following:
If you can, please include the following details:
* An MCVE (minimum complete verifiable example)  this is a short code snippet which demonstrates the error in the
the simplest possible (or just a simple) way.
* Which versions of Yew the vulnerability is present in
* What effects the vulnerability has and how serious the vulnerability is
1. Click on the **Security** tab and then click on the **"Report a Vulnerability"** button.
![Report a Vulnerability](https://github.com/shubhsharma19/yew/assets/69891912/810b0297-65c0-42e1-9935-08f026387bf7)
2. After that give a **title** and a **description**.
![Title and Description](https://github.com/shubhsharma19/yew/assets/69891912/3686459b-c7b4-49ea-92cf-5313c4ccd756)
When reporting the vulnerability, please provide the following information, if possible:
- **MCVE (Minimum Complete Verifiable Example)**: Please include a concise code snippet that demonstrates the error in a simplified manner.
- **Versions of Yew**: Specify the versions of Yew in which the vulnerability is present. This helps us narrow down the scope of the issue and assess its impact accurately.
- **Impact and Severity**: Describe the effects of the vulnerability and its seriousness. Provide details about any potential risks, security breaches, or the impact it may have on the system.
> For contacting the maintainers, you can reach out to them via email at maintainers@yew.rs