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.
Puedes crear lineamientos de contribución predeterminados para tu organización. Para obtener más información, consulta "Crear un archivo de salud predeterminado para la comunidad"
Sugerencia: los mantenedores de repositorios pueden establecer pautas específicas para las propuestas al crear una plantilla de propuesta o de solicitud de extracción para el repositorio. Para obtener más información, consulta "Acerca de las plantillas de propuestas y solicitudes de extracción".
Agregar un archivo CONTRIBUTING
-
En GitHub Enterprise, visita la página principal del repositorio.
-
Sobre la lista de archivos, da clic en Crear archivo nuevo.
-
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
docsdel repositorio, escribe docs/ para crear el nuevo directorio, y luego CONTRIBUTING.
-
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.
-
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 obtener más información, consulta "Crear una confirmación con co-autores múltiples".
-
Debajo de los campos del mensaje de confirmación, decide si deseas agregar tu confirmación a la rama actual o a una rama nueva. 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 obtener más información, consulta "Crear una solicitud de extracción nueva".
-
Da 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"