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

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. 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 comunidad	Descripción
ACCESSIBILITY.md	Un archivo ACCESSIBILITY describe los objetivos de accesibilidad de un proyecto, las barreras conocidas y el proceso de creación de informes. Para más información, consulta Adición de una página de accesibilidad al repositorio.
CODE_OF_CONDUCT.md	Un archivo CODE_OF_CONDUCT define las normas estándar para participar en una comunidad. Para más información, consulta Agregar un código de conducta a tu proyecto.
CONTRIBUTING.md	Un 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ón	Los 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.yml	Un 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.yml	Las 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.md	Un 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.
VULNERABILITY_REPORT.yml o VULNERABILITY_REPORT.yaml	Un formulario de informe de vulnerabilidad personaliza la información que las personas que notifican deben proporcionar cuando informan de forma privada de una vulnerabilidad. Para más información, consulta Configuración de informes de vulnerabilidades privadas para un repositorio.
SUPPORT.md	Un 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.

   

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

1. En el campo "Nombre del repositorio", escribe .github.
2. Opcionalmente, en el campo "Descripción", teclea una descripción.
3. Asegúrese de que el estado del repositorio esté establecido 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. Almacene el archivo en la ubicación necesaria:
   • Almacene formularios de categoría de discusión en .github/DISCUSSION_TEMPLATE.
   • Almacene plantillas de incidencias y su archivo de configuración en .github/ISSUE_TEMPLATE.

• Almacene FUNDING.yml, VULNERABILITY_REPORT.ymly VULNERABILITY_REPORT.yaml en la .github carpeta .

  • Almacene todos los demás archivos admitidos en la raíz del repositorio, la carpeta .github o la carpeta docs.

  Para más información, consulta Crear nuevos archivos.