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 predeterminados de mantenimiento de la comunidad constituyen un conjunto de archivos predefinidos que proporcionan instrucciones y plantillas para mantener un proyecto de código abierto correcto y colaborativo. Estos archivos te permiten automatizar y estandarizar varios aspectos del desarrollo y la interacción con la comunidad de tu proyecto, promoviendo la transparencia, los procedimientos recomendados y la colaboración.

Puedes agregar archivos de mantenimiento de la comunidad predeterminados a un repositorio público denominado .github y GitHub Enterprise Server usará y mostrará archivos predeterminados para cualquier repositorio propiedad de la cuenta que no tenga su propio archivo de ese tipo en el orden siguiente:

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

Si no se encuentra ningún archivo correspondiente en el repositorio actual, GitHub Enterprise Server usará el archivo predeterminado del repositorio .github, siguiendo el mismo orden de precedencia.

Por ejemplo, cualquiera que cree una propuesta o solicitud de cambios en un repositorio que no tenga su propio archivo CONTRIBUTING.md verá un enlace en el archivo CONTRIBUTING.md predeterminado del repositorio .github. Sin embargo, si un repositorio tiene archivos en una carpeta .github/ISSUE_TEMPLATE propia, incluidas las plantillas de incidencia o un archivo _config.yml, no se usará el contenido de la carpeta .github/ISSUE_TEMPLATE predeterminada. Esto permite a los mantenedores del 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 clones, paquetes ni descargas.

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
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.
GOVERNANCE.mdUn archivo GOVERNANCE permite a los usuarios saber cómo se gobierna el proyecto. Por ejemplo, podría analizar los roles del proyecto y cómo se toman las decisiones.
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.
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.

  3. En el campo "Nombre del repositorio", escribe .github.

  4. Opcionalmente, en el campo "Descripción", teclea una descripción.

  5. Asegúrate de que el estado del repositorio esté establecido en Público. Un repositorio de archivos predeterminados no puede ser privado.

  6. Seleccione Initialize this repository with a README (Inicializar este repositorio con un archivo Léame).

  7. Haga clic en Create repository (Crear repositorio).

  8. En el repositorio, crea uno de los archivos admitidos de estado de la comunidad. Las plantillas de incidencia y su archivo de configuración deben estar en una carpeta denominada .github/ISSUE_TEMPLATE. Todos los demás archivos admitidos pueden estar en la raíz del repositorio, la carpeta .github o la carpeta docs. Para más información, consulta Crear nuevos archivos.