Configurar pautas para los colaboradores de repositorios

Para ayudar a los colaboradores de tu proyecto a realizar un buen trabajo, puedes agregar un archivo con las pautas de colaboración a la raíz del repositorio de tu proyecto, carpeta docs, o .github. Cuando alguien abre una solicitud de extracción o crea una propuesta, verán un enlace a ese archivo.

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.

Agregar un archivo CONTRIBUTING

1. En GitHub Enterprise, visita la página principal del repositorio.

2. Sobre la lista de archivos, haz clic en Crear nuevo archivo.

   

3. Decide si almacenar tus pautas de contribución en la raíz de tu repositorio, el directorio docs, o el directorio .github. Después, en el campo nombre de archivo, escribe el nombre y la extensión del archivo. Los nombres de archivos de las pautas de contribución no distinguen entre mayúsculas y minúsculas y pueden tener una extensión .md o .txt.

   
   • Para hacer visibles tus pautas de contribución en el directorio raíz del repositorio, escribe CONTRIBUTING.
   • Para hacer visibles tus pautas de contribución en el directorio docs del repositorio, escribe docs/ para crear el nuevo directorio, y luego CONTRIBUTING.

4. 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.

5. En la parte inferior de la página, escribe un mensaje de confirmación breve y significativo que describa el cambio que has realizado en el archivo. Puedes atribuir la confirmación a más de un autor en el mensaje de confirmación. Para obtener más información, consulta "Crear una confirmación con distintos coautores."

   

6. Debajo de los campos para los mensajes de confirmación, decide si deseas agregar tu confirmación a la rama actual o a una nueva rama. Si tu rama actual es master, debes elegir crear una nueva rama para tu confirmación y luego crear una solicitud de extracción.

   

7. Haz clic en Proponer nuevo archivo.

   

Ejemplos de pautas de contribución

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

• Pautas de contribución del Editor Atom .
• Pautas de contribución de Ruby on Rails .
• Pautas de contribución de Open Government .

Leer más

• La sección de la Guía de código abierto "Iniciar un proyecto de código abierto"
• "Agregar una licencia a un repositorio"