Editing a security advisory

You can edit the metadata and description for a security advisory if you need to update details or correct errors.

In this article

People with admin permissions to a security advisory can edit the security advisory.

About credits for security advisories

You can credit people who helped discover, report, or fix a security vulnerability. If you credit someone, they can choose to accept or decline credit.

If someone accepts credit, the person's username appears in the "Credits" section of the security advisory. Anyone with read access to the repository can see the advisory and the people who accepted credit for it.

Editing a security advisory

  1. On GitHub, navigate to the main page of the repository.
  2. Under your repository name, click Security.
    Security tab
  3. In the left sidebar, click Security advisories.
    Security advisories tab
  4. In the "Security Advisories" list, click the security advisory you'd like to edit.
  5. In the upper-right corner of the details for the security advisory, click .
    Edit button for a security advisory
  6. Edit the product and versions affected by the security vulnerability that this security advisory addresses.
    Security advisory metadata
  7. Select the severity of the security vulnerability. To assign a CVSS score, select "Assess severity using CVSS" and click the appropriate values in the calculator. GitHub calculates the score according to the "Common Vulnerability Scoring System Calculator."
    Drop-down menu to select the severity
  8. Add common weakness enumerators (CWEs) for the kinds of security weaknesses that this security advisory addresses. For a full list of CWEs, see the "Common Weakness Enumeration" from MITRE.
  9. If you have an existing CVE identifier, select "I have an existing CVE identifier" and type the CVE identifier in the text box. Otherwise, you can request a CVE from GitHub later.
  10. Type a description of the security vulnerability.
    Security advisory vulnerability description
  11. Optionally, edit the "Credits" for the security advisory.
    Credits for a security advisory
  12. Click Update security advisory.
    Add button
  13. The people listed in the "Credits" section will receive an email or web notification inviting them to accept credit. If a person accepts, their username will be publicly visible once the security advisory is published.

Further reading

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.