Creación de un archivo predeterminado de mantenimiento de la comunidad

Puedes crear archivos predeterminados para la salud de la comunidad, como CONTRIBUTING (Contribuciones) y CODE_OF_CONDUCT (Código de conducta). Los archivos predeterminados se utilizarán para cualquier repositorio que pertenezca a la cuenta que no contiene su propio archivo de este tipo.

En este artículo

Acerca de los archivos predeterminados del estado de la comunidad

Los archivos de mantenimiento de la comunidad predeterminados son un conjunto de archivos predefinidos que proporcionan instrucciones y plantillas para mantener un proyecto de código abierto correcto y colaborativo. Estos archivos le permiten automatizar y estandarizar varios aspectos del desarrollo y la interacción con la comunidad de su proyecto, promoviendo la transparencia, los procedimientos recomendados y la colaboración.

Puede agregar archivos de mantenimiento de la comunidad predeterminados a un repositorio denominado .github. Para , organización con usuarios administradosel .github repositorio debe ser interno. Para todas las demás cuentas, el .github repositorio debe ser público.

GitHub usará y mostrará archivos predeterminados para cualquier repositorio propiedad de la cuenta, independientemente de la visibilidad del repositorio de destino, que no tenga su propio archivo de ese tipo. Para los archivos admitidos que se pueden almacenar en más de una ubicación, GitHub usa el siguiente orden de prioridad:

  • La carpeta .github
  • La raíz del repositorio
  • La carpeta docs

Si no se encuentra ningún archivo correspondiente en el repositorio actual, GitHub usará el archivo predeterminado del .github repositorio. Para los archivos que se pueden almacenar en más de una ubicación, GitHub sigue el mismo orden de prioridad en el .github repositorio.

Por ejemplo, cualquiera que crea una incidencia o solicitud de incorporación de cambios en un repositorio que no tenga su propio archivo CONTRIBUTING.md verá un enlace a CONTRIBUTING.md predeterminado desde el repositorio de .github. Sin embargo, si un repositorio define plantillas de problema válidas o configuración de plantilla de problema en su propia .github/ISSUE_TEMPLATE carpeta, no se usará ninguno del contenido de la carpeta predeterminada .github/ISSUE_TEMPLATE . Esto permite a los mantenedores de repositorio invalidar los archivos predeterminados con plantillas o contenido específicos por repositorio.

Almacenar los archivos en el repositorio .github permite realizar cambios en los valores predeterminados en un solo lugar. Además, no aparecerán en el explorador de archivos ni en el historial de Git de los repositorios individuales, y no están incluidos en sus clonaciones, paquetes ni descargas.

Como mantenedor de un repositorio, puede utilizar la lista de comprobación de las normas comunitarias para ver si su proyecto cumple las normas comunitarias recomendadas para ayudar a la gente a utilizar y contribuir a su proyecto. Para más información, consulta Acerca de los perfiles de comunidad para los repositorios públicos.

Acerca de las políticas de seguridad

Después de que alguien notifique una vulnerabilidad de seguridad en el proyecto, puede usar GitHub Security Advisories para revelar, corregir y publicar información sobre la vulnerabilidad. Para obtener más información sobre el proceso de generación de informes y la divulgación de vulnerabilidades en GitHub, vea Divulgación coordinada de vulnerabilidades de seguridad. Para obtener más información sobre los avisos de seguridad del repositorio, consulte Asesorías de seguridad de repositorio.

Para obtener un ejemplo real del archivo SECURITY.md, consulte https://github.com/electron/electron/blob/main/SECURITY.md.

Tipos de archivo admitidos

Puedes crear valores predeterminados en tu cuenta de la organización o personal para los siguientes archivos de estado de la comunidad:

Archivo de mantenimiento de la comunidadDescripción
CODE_OF_CONDUCT.mdUn archivo CODE_OF_CONDUCT define estándares para participar en una comunidad. Para obtener más información, consulte Agregar un código de conducta a tu proyecto.
CONTRIBUTING.mdUn archivo CONTRIBUTING indica cómo las personas deben contribuir al proyecto. Para más información, consulta Configurar pautas para los colaboradores de repositorios.
Formularios de categorías de discusiónLos formularios de categoría de discusión personalizan las plantillas que están disponibles para que los miembros de la comunidad las usen cuando abran nuevas discusiones en el repositorio. Para más información, consulta Creación de formularios de categoría de discusión.
FUNDING.ymlUn archivo FUNDING muestra un botón de patrocinador en el repositorio para aumentar la visibilidad de las opciones de financiación del proyecto de código abierto. Para más información, consulta Mostrando un botón de patrocinador en tu repositorio.
Plantillas de problemas y de solicitudes de incorporación de cambios y config.ymlLas plantillas de incidencia y de solicitud de cambios personalizan y normalizan la información que desea que los colaboradores incluyan cuando abran incidencias y solicitudes de cambios en el repositorio. Para más información, consulta Acerca de las plantillas de propuestas y solicitudes de extracción.

Si una plantilla de incidencia establece una etiqueta, esa etiqueta debe crearse en el repositorio de .github y todos los repositorios en los que se usará la plantilla.
SECURITY.mdUn archivo SECURITY proporciona instrucciones para informar de una vulnerabilidad de seguridad en el proyecto y una descripción con un hipervínculo al archivo. Para más información, consulta Agregar una política de seguridad a tu repositorio.
SUPPORT.mdUn archivo SUPPORT permite a los usuarios conocer formas de obtener ayuda con el proyecto. Para más información, consulta Agregar recursos de soporte a tu proyecto.

No puedes crear un archivo de licencia predeterminado. Los archivos de licencia se deben agregar a repositorios individuales, de manera que el archivo se incluirá cuando el proyecto se clone, se coloque dentro de un paquete o se descargue.

Crear un repositorio para archivos predeterminados

  1. En la esquina superior derecha de cualquier página, selecciona y luego haz clic en Nuevo repositorio.

    Captura de pantalla del menú desplegable GitHub que muestra las opciones para crear nuevos elementos. El elemento de menú "New repository" está resaltado en naranja oscuro.

  2. Usa el menú desplegable Propietario y selecciona la cuenta de la organización o personal para la que quieras crear archivos predeterminados.

Captura de pantalla del menú del propietario de un repositorio de GitHub nuevo. El menú muestra dos opciones, octocat y github.

  1. En el campo "Nombre del repositorio", escribe .github.
  2. Opcionalmente, en el campo "Descripción", teclea una descripción.
  3. Si va a crear el repositorio para , organización con usuarios administradosestablezca el estado del repositorio en Interno. Para cualquier otra cuenta, establezca el estado en Público. Un repositorio de archivos predeterminados no puede ser privado.
  4. Cambie Agregar README a Activado.
  5. Haga clic en Create repository (Crear repositorio).
  6. En el repositorio, crea uno de los archivos admitidos de estado de la comunidad. Los formularios de categoría de discusión deben estar en una carpeta denominada .github/DISCUSSION_TEMPLATE. Las plantillas de incidencia y su archivo de configuración deben estar en una carpeta denominada .github/ISSUE_TEMPLATE. Un FUNDING.yml archivo debe estar en la .github carpeta . Todos los demás archivos admitidos pueden estar en la raíz del repositorio, la .github carpeta o la docs carpeta . Para más información, consulta Crear nuevos archivos.