Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la documentación en inglés. Si existe un problema con las traducciones en esta página, por favor infórmanos.

Configurar pautas para los colaboradores de repositorios

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

En este artículo

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.

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. Para más información, consulta "Crear un archivo de estado de comunidad predeterminado para tu organización".

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

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

  2. Above the file list, click Create new file.

    The New file button

  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.

    Nombre del nuevo archivo

    • 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. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."

    Mensaje de confirmación de tu cambio

  6. 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. If your current branch is master, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."

    Confirmar opciones de rama

  7. Click Propose new file.

    Propose new file button

Ejemplos de pautas de contribución

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

Leer más

Pregunta a una persona

¿No puedes encontrar lo que estás buscando?

Contáctanos