Skip to main content

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.

Acerca de los archivos predeterminados del estado de la comunidad

Puede agregar archivos de mantenimiento de la comunidad predeterminados a un repositorio público denominado .github, en la raíz del repositorio o en las carpetas docs o .github.

GitHub Enterprise Cloud utilizará y mostrará los archivos predeterminados para cualquier repositorio que pertenezca a la cuenta que no tenga su propio archivo de ese tipo en cualquiera de los siguientes lugares:

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

Por ejemplo, cualquiera que crea una propuesta o solicitud de cambios en un repositorio que no tenga su propio archivo de "CONTRIBUTING" verá un enlace en el archivo "CONTRIBUTING" predeterminado. 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.

Los archivos predeterminados no están incluidos en los clones, paquetes ni descargas de repositorios individuales porque solo se almacenan en el repositorio .github.

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 estado de la comunidad | Descripción --- | --- CODE_OF_CONDUCT.md | Un archivo CODE_OF_CONDUCT define los estándares de participación en una comunidad. Para más información, vea "Adición de un código de conducta al proyecto". CONTRIBUTING.md | Un archivo CONTRIBUTING comunica cómo deben contribuir al proyecto los usuarios. Para más información, vea "Establecimiento de instrucciones para colaboradores del repositorio". FUNDING.yml | Un archivo FUNDING muestra un botón de patrocinador en el repositorio para aumentar la visibilidad de las opciones de financiación para el proyecto de código abierto. Para más información, vea "Representación de un botón de patrocinador en el repositorio". Plantillas de incidencia y solicitud de incorporación de cambios y config.yml | Las plantillas de incidencia y solicitud de incorporación de cambios personalizan y estandarizan la información que quiere que los colaboradores incluyan cuando abren incidencias y solicitudes de incorporación de cambios en el repositorio. Para más información, vea "Acerca de las plantillas de incidencia y solicitud de incorporación de cambios". SECURITY.md | Un archivo SECURITY proporciona instrucciones sobre cómo notificar una vulnerabilidad de seguridad en el proyecto. Para más información, vea "Adición de una directiva de seguridad al repositorio". SUPPORT.md | Un archivo SUPPORT permite a los usuarios conocer las formas de obtener ayuda con el proyecto. Para más información, vea "Adición de recursos de soporte técnico al 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, utiliza el menú desplegable y selecciona New repository (Nuevo repositorio). Menú desplegable con opción para crear un repositorio
  2. Usa el menú desplegable Propietario y selecciona la cuenta de la organización o personal para la que quieras crear archivos predeterminados. Menú desplegable Propietario
  3. Escriba .github como nombre del repositorio y una descripción opcional. Campo para crear un repositorio
  4. Asegúrese de que el estado del repositorio se establece en Público (los repositorios para los archivos predeterminados no pueden ser privados). Botones de opción para seleccionar el estado público o privado 1. Seleccione Initialize this repository with a README (Inicializar este repositorio con un archivo Léame). Inicializar este repositorio con una casilla archivo Léame 1. Haga clic en Create repository (Crear repositorio). Botón para crear un repositorio
  5. 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, vea "Creación de archivos".