diff --git a/assets/images/help/security/security-advisories-suggest-improvement-reason.png b/assets/images/help/security/security-advisories-suggest-improvement-reason.png new file mode 100644 index 0000000000..1d8857c46d Binary files /dev/null and b/assets/images/help/security/security-advisories-suggest-improvement-reason.png differ diff --git a/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md b/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md index 600e21ec9b..1df683d98c 100644 --- a/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md +++ b/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md @@ -27,12 +27,18 @@ Only repository owners and administrators can edit repository-level security adv ## Editing advisories in the GitHub Advisory Database 1. Navigate to https://github.com/advisories. -2. Select the security advisory you would like to contribute to. -3. On the right-hand side of the page, click the **Suggest improvements for this vulnerability** link. - ![Suggest improvements link](/assets/images/help/security/suggest-improvements-to-advisory.png) -4. In the contribution form, make the desired improvements. You can edit or add any detail. -5. When you finish editing the advisory, click **Submit improvements**. -6. Once you submit your improvements, a pull request containing your changes will be created for review in [github/advisory-database](https://github.com/github/advisory-database) by the {% data variables.product.prodname_security %} curation team. If the advisory originated from a {% data variables.product.prodname_dotcom %} repository, we will also tag the original publisher for optional commentary. You can view the pull request and get notifications when it is updated or closed. +1. Select the security advisory you would like to contribute to. +1. On the right-hand side of the page, click the **Suggest improvements for this vulnerability** link. + + ![Screenshot of the suggest improvements link](/assets/images/help/security/suggest-improvements-to-advisory.png) + +1. In the contribution form, make the desired improvements. You can edit or add any detail.{% ifversion security-advisories-reason-for-change %} +1. Under **Reason for change**, explain why you want to make this improvement. If you include links to supporting material this will help our reviewers. + + ![Screenshot of the reason for change field](/assets/images/help/security/security-advisories-suggest-improvement-reason.png){% endif %} + +1. When you finish editing the advisory, click **Submit improvements**. +1. Once you submit your improvements, a pull request containing your changes will be created for review in [github/advisory-database](https://github.com/github/advisory-database) by the {% data variables.product.prodname_security %} curation team. If the advisory originated from a {% data variables.product.prodname_dotcom %} repository, we will also tag the original publisher for optional commentary. You can view the pull request and get notifications when it is updated or closed. You can also open a pull request directly on an advisory file in the [github/advisory-database](https://github.com/github/advisory-database) repository. For more information, see the [contribution guidelines](https://github.com/github/advisory-database/blob/main/CONTRIBUTING.md). diff --git a/data/features/security-advisories-reason-for-change.yml b/data/features/security-advisories-reason-for-change.yml new file mode 100644 index 0000000000..615c580f3f --- /dev/null +++ b/data/features/security-advisories-reason-for-change.yml @@ -0,0 +1,7 @@ +# Reference: #7792 +# Documentation for incremental improvements to community contributions +versions: + fpt: '*' + ghec: '*' + ghes: '>=3.8' + ghae: 'issue-7792'