Skip to main content

Configurar pautas para los colaboradores de repositorios

Puedes crear pautas para comunicar cómo pueden contribuir las personas a tu proyecto.

Acerca de los lineamientos de contribución

Para ayudar a los colaboradores de su proyecto a realizar un buen trabajo, puede agregar un archivo con las pautas de contribución a la raíz del repositorio del proyecto, docs o la carpeta .github. Cuando alguien abre una solicitud de extracción o crea una propuesta, verán un enlace a ese archivo. El vínculo a las pautas de contribución también aparece en la página contribute del repositorio. Para obtener un ejemplo de una página contribute, vea github/docs/contribute.

contributing-guidelines

Para el propietario del repositorio, las pautas de contribución son una manera de comunicar cómo deben contribuir las personas.

Para los colaboradores, las pautas los ayudan a verificar que están presentando solicitudes de extracción conformadas correctamente y abriendo propuestas útiles.

Tanto para los propietarios como para los colaboradores, las pautas de contribución ahorran tiempo y evitan inconvenientes generados por solicitudes de extracción o propuestas creadas de manera incorrecta que deben ser rechazadas o se deben volver a presentar.

Puedes crear pautas de contribución predeterminadas para tu organización o cuenta personal. Para más información, vea "Creación de un archivo de estado de la comunidad predeterminado".

Sugerencia: los mantenedores de repositorios pueden establecer pautas específicas para las incidencias creando una plantilla de incidencia o de solicitud de incorporación de cambios para el repositorio. Para más información, vea "Acerca de las plantillas de incidencias y solicitudes de incorporación de cambios".

Agregar un archivo CONTRIBUTING

  1. En your GitHub Enterprise Server instance, vaya a la página principal del repositorio. 1. Encima de la lista de archivos, haga clic en Create new file (Crear archivo) mediante la lista desplegable Add file (Agregar archivo). "Crear archivo" en la lista desplegable "Agregar archivo"
  2. Decida si quiere almacenar las pautas de contribución en la raíz del repositorio, en docs o en el directorio .github. Después, en el campo nombre de archivo, escribe el nombre y la extensión del archivo. Los nombres de archivo de los lineamientos de contribución no distinguen entre mayúsculas y minúsculas. Los archivos se interpretan en formato de texto rico si la extensión de archivo se encuentra en un formato compatible. Para obtener más información, vea "Trabajar con archivos que no son de código". Nuevo nombre de archivo
    • Para hacer visibles sus pautas de contribución en el directorio raíz del repositorio, escriba CONTRIBUTING.
    • Para hacer visible sus pautas de contribución en el directorio docs del repositorio, escriba docs/ para crear el directorio y luego CONTRIBUTING.
    • Si un repositorio contiene más de un archivo CONTRIBUTING, el archivo que se muestra en los vínculos se elige de las ubicaciones en el siguiente orden: el directorio .github, luego el directorio raíz del repositorio y finalmente el directorio docs.
  3. En el nuevo archivo, agrega las pautas de contribución. Pueden incluir:
    • Pasos para crear buenas propuestas o solicitudes de extracción.
    • Enlaces a la documentación externa, listas de correos o un código de conducta.
    • Expectativas de comportamiento y de la comunidad.
  4. En la parte inferior de la página, teclea un mensaje de confirmación corto y significativo que describa el cambio que realizaste al archivo. Puedes atribuir el cambio a mas de un autor en el mensaje del mismo. Para más información, vea "Creación de una confirmación con varios coautores". Mensaje de confirmación para el cambio 1. Debajo de los campos para el mensaje de confirmación, decide si deseas agregar tu confirmación a la rama actual o a una rama nueva. Debajo de los campos del mensaje de confirmación, decide si deseas agregar tu confirmación a la rama actual o a una nueva rama. Si tu rama actual es la rama predeterminada, debes elegir crear una nueva rama para tu confirmación y después crear una solicitud de extracción. Para más información, vea "Creación de una solicitud de incorporación de cambios". Opciones de confirmación de rama 1. Haga clic en Proponer nuevo archivo. Botón para proponer un nuevo archivo

Ejemplos de pautas de contribución

Si estás confundido, aquí hay algunos buenos ejemplos de pautas de contribución:

Información adicional