Adding a security policy to your repository

You can give instructions for how to report a security vulnerability in your project by adding a security policy to your repository.

About security policies

To give people instructions for reporting security vulnerabilities in your project, you can add a SECURITY.md file to your repository's root, docs, or .github folder. When someone creates an issue in your repository, they will see a link to your project's security policy.

You can create a default security policy for your organization or user account. For more information, see "Creating a default community health file."

Tip: To help people find your security policy, you can link to your SECURITY.md file from other places in your repository, such as your README file. For more information, see "About READMEs."

After someone reports a security vulnerability in your project, you can use GitHub Security Advisories to disclose, fix, and publish information about the vulnerability. For more information about the process of reporting and disclosing vulnerabilities in GitHub, see "About coordinated disclosure of security vulnerabilities." For more information about GitHub Security Advisories, see "About GitHub Security Advisories."

También puedes unirte a GitHub Security Lab para buscar temas relacionados con seguridad y contribuir con las herramientas y proyectos de seguridad.

Adding a security policy to your repository

  1. En GitHub, visita la página principal del repositorio.

  2. Debajo de tu nombre de repositorio, da clic en Seguridad. Pestaña de seguridad

  3. In the left sidebar, click Security policy. Security policy tab

  4. Click Start setup. Start setup button

  5. In the new SECURITY.md file, add information about supported versions of your project and how to report a vulnerability.

  6. En la parte inferior de la página, teclea un mensaje de confirmación corto y significativo que describa el cambio que realizaste al archivo. Puedes atribuir el cambio a mas de un autor en el mensaje del mismo. Para obtener más información, consulta "Crear una confirmación con co-autores múltiples". Mensaje de confirmación de tu cambio

  7. Debajo de los campos de mensaje de confirmación, haz clic en el menú desplegable de dirección de correo electrónico y elige una dirección de correo electrónico de autor de Git. Únicamente las direcciones de correo electrónico verificadas aparecen en el menú desplegable. Si habilitaste privacidad de la dirección de correo electrónico, entonces <username>@users.noreply.github.com es la dirección de correo electrónico de autor de la confirmación por defecto. Para obtener más información, consulta "Establecer tu dirección de correo electrónico de confirmación". Escoger direcciones de correo electrónico para confirmaciones

  8. Debajo de los campos del mensaje de confirmación, decide si deseas agregar tu confirmación a la rama actual o a una rama nueva. Si tu rama actual es la rama predeterminada, debes elegir crear una nueva rama para tu confirmación y después crear una solicitud de extracción. Para obtener más información, consulta "Crear una solicitud de extracción nueva". Confirmar opciones de rama

  9. Haz clic en Proponer cambio en el archivo. Botón para proponer cambio de archivo

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

O, learn how to contribute.