Skip to content

Commit 3402bed

Browse files
Apply suggestions from code review
Co-authored-by: Felicity Chapman <felicitymay@github.com>
1 parent 2b9c5ba commit 3402bed

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

content/github/managing-security-vulnerabilities/about-disclosing-vulnerabilities.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,16 @@ The initial report of a vulnerability is made privately, and the full details ar
1717
Security researchers should report vulnerabilities privately to maintainers. It's not acceptable to:
1818
- Disclose the vulnerability publicly
1919
- Not contact the maintainer
20-
- Disclose the vulnerability before the code has been patched
20+
- Disclose the vulnerability before a fixed version of the code is available
2121

22-
It's fine for security researchers to disclose a vulnerability publicly after a period of time, if they have tried to contact the maintainers and not received a response, or contacted them and been asked to wait too long to disclose it.
22+
It's acceptable for security researchers to disclose a vulnerability publicly after a period of time, if they have tried to contact the maintainers and not received a response, or contacted them and been asked to wait too long to disclose it.
2323

2424
#### Best practices for maintainers
2525

26-
Maintainers should disclose vulnerabilities in a timely manner, if a security vulnerability has been found in their repository. It's not acceptable to:
27-
- Not disclose the vulnerability
28-
- Not identify the vulnerability as a security issue
29-
- Wait an unacceptably long time to create a fix
26+
Maintainers should disclose vulnerabilities in a timely manner. If there is a security vulnerability in your repository, you should:
27+
- Treat the vulnerability as a security issue rather than a simple bug
28+
- Plan to disclose the vulnerability responsibly
29+
- Aim to publish a fix as soon as you can
3030

3131
Publishing the details of a security vulnerability doesn't make maintainers look bad. Security vulnerabilities are present everywhere in sofware nowadays, and users will trust maintainers who have a clear and established process for disclosing security vulnerabilities in their code.
3232

@@ -47,4 +47,4 @@ The process for reporting and disclosing vulnerabilities in {% data variables.pr
4747
As a maintainer, to disclose a vulnerability that exists in your repository (for example if someone got in touch and reported a vulnerability to you), you first create a draft security advisory in your package's repository in {% data variables.product.prodname_dotcom %}. {% data reusables.security-advisory.security-advisory-overview %} For more information, see "[About {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)."
4848

4949

50-
To get started, see "[Creating a security advisory](/github/managing-security-vulnerabilities/creating-a-security-advisory)."
50+
To get started, see "[Creating a security advisory](/github/managing-security-vulnerabilities/creating-a-security-advisory)."
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Vulnerability disclosure is an area where collaboration between security researchers and organizations is very important, from the moment a potentially harmful security vulnerability is found, right until a patch is available, and the vulnerability is disclosed to the world. Typically, when someone lets an organization maintainer know privately about a security vulnerability, the maintainer develops a fix, validates it, and notifies the repository users.
1+
Vulnerability disclosure is an area where collaboration between security researchers and project maintainers is very important, from the moment a potentially harmful security vulnerability is found, right until a patch is available, and the vulnerability is disclosed to the world. Typically, when someone lets a maintainer know privately about a security vulnerability, the maintainer develops a fix, validates it, and notifies the repository users.

0 commit comments

Comments
 (0)