Acerca de los archivos predeterminados del estado de la comunidad
Puedes agregar archivos de salud comunitaria predeterminados a un repositorio público llamado .github en la raíz del repositorio o en las carpetas de docs o de .github .
GitHub Enterprise Server 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 cualquier archivo en su propia carpeta de .github/ISSUE_TEMPLATE, incluyendo las plantillas de reporte de problemas o un archivode config.yml, no se utilizará ninguno de los contenidos de la carpeta .github/ISSUE_TEMPLATE.
Los archivos predeterminados no están incluidos en los clones, paquetes ni descargas de repositorios individuales porque se almacenan únicamente en el repositorio .github.
Tipos de archivos admitidos
Puedes crear recursos predeterminados en tu cuenta de organización o personal para los siguientes archivos de salud comunitaria:
| Archivo de salud de la comunidad | Descripción |
|---|---|
| CONTRIBUTING.md | Un archivo CONTRIBUTING comunica cómo pueden contribuir las personas con tu proyecto. Para obtener más información, consulta "Establecer pautas para los colaboradores del repositorio". |
| Plantillas de reporte de problemas y solicitudes de extracción y config.yml | Las plantillas de propuestas y solicitudes de extracción personalizan y estandarizan la información que quieres que incluyan los colaboradores cuando abren propuestas y solicitudes de extracción en tu repositorio. Para obtener más información, consulta "Acerca de las plantillas de propuestas y de solicitudes de extracción". |
| SECURITY.md | Un archivo de seguridad proporciona indicaciones para saber cómo reportar la vulnerabilidad de seguridad de tu proyecto. Para obtener más información, consulta "Aumentar la seguridad para tu repositorio". |
| SUPPORT.md | Un archivo SOPPORT les permite a las personas conocer las formas de obtener ayuda con tu proyecto. Para obtener 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
- En la esquina superior derecha de cualquier página, utiliza el menú desplegable y selecciona Repositorio Nuevo.
- Utiliza el menú desplegable de Propietario y selecciona a la cuenta de organización o personal para la cual quieras crear archivos predeterminados.
- Escribe .github como nombre para tu repositorio y escribe una descripción opcional.
- Asegúrate de que el estado del repositorio se encuentre configurado en Público (los repositorios para los archivos predeterminados no pueden ser privados).
- Selecciona Inicializar este repositiro con un README.
- Haz clic en Crear repositorio.
- En el repositorio, crea uno de los archivos admitidos de estado de la comunidad. Las plantillas de reporte de problemas y su archivo de configuración deben estar en una carpeta llamada
.github/ISSUE_TEMPLATE. El resto de los archivos compatibles podrían estar en la raíz del repositorio, en la carpeta de.githubo en la dedocs. Para obtener más información, consulta "Crear nuevos archivos."