Skip to main content

Editing security advisories in the GitHub Advisory Database

You can submit improvements to any advisory published in the GitHub Advisory Database by making a community contribution.

Editing advisories in the GitHub Advisory Database

The advisories in the GitHub Advisory Database are global security advisories. For more information about global security advisories, see About global security advisories.

Anyone can suggest improvements on any global security advisory in the GitHub Advisory Database by making a community contribution. A community contribution is a pull request submitted to the github/advisory-database repository that improves the content of a global security advisory. When you make a community contribution, you can edit or add any detail, including additionally affected ecosystems, severity level or description of who is impacted. The GitHub Security Lab curation team will review the submitted contributions and publish them onto the GitHub Advisory Database if accepted.

If we accept and publish the community contribution, the person who submitted the community contribution pull request will automatically be assigned a credit type of "Analyst". For more information, see Creating a repository security advisory.

Only repository owners and administrators can edit repository-level security advisories. For more information, see Editing a repository security advisory.

  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.
  4. In the "Improve security advisory" form, make the desired improvements. You can edit or add any detail. For information about correctly specifying information on the form, including affected versions, see Best practices for writing repository security advisories.
  5. Under Reason for change, explain why you want to make this improvement. If you include links to supporting material this will help our reviewers.
  6. When you finish editing the advisory, click Submit improvements.
  7. Once you submit your community contribution, a pull request containing your changes will be created for review in github/advisory-database by the GitHub Security Lab curation team. If the advisory originated from a GitHub 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 repository. For more information, see the contribution guidelines.