Crear una plantilla de solicitud de extracción para tu repositorio
Cuando agregas una plantilla de solicitud de extracción a tu repositorio, los colaboradores del proyecto verán automáticamente los contenidos de la plantilla en el cuerpo de la solicitud de extracción.
Para obtener más información, consulta "Acerca de las plantillas de propuestas y solicitudes de extracción".
Puedes crear un subdirectorio PULL_REQUEST_TEMPLATE/ en alguna de las carpetas admitidas para incluir múltiples plantillas de solicitudes de extracción, y utilizar el parámetro de consulta template
para especificar la plantilla que completará el cuerpo de la solicitud de extracción. Para obtener más información, consulta "Acerca de la automatización para las propuestas y las solicitudes de extracción con parámetros de consulta "
Puedes crear plantillas de solicitud de extracción predeterminadas para tu organización. Para más información, consulta "Crear un archivo de estado de comunidad predeterminado para tu organización".
Agregar una plantilla de solicitud de extracción
-
En GitHub, visita la página principal del repositorio.
-
Above the file list, click Create new file.
-
En el campo del nombre del archivo:
- Para que tus plantillas de solicitud de extracción sean visibles en el directorio raíz del repositorio, escribe el nombre de tu plantilla de solicitud de extracción. Por ejemplo,
pull_request_template.md
. - Para que tus plantillas de solicitud de extracción sean visibles en el directorio
docs
del repositorio, escribe docs y luego el nombre de tu plantilla de solicitud de extracción. Por ejemplo,docs/pull_request_template.md
. - Para almacenar tu archivo en un directorio escondido, escribe .github/ seguido del nombre de tu plantilla de solicitud de extracción. Por ejemplo,
.github/pull_request_template.md
. - Para crear plantillas de solicitud de extracción múltiples y utilizar el parámetro de consulta
template
para especificar una plantilla para completar el cuerpo de la solicitud de extracción, escribe .github/PULL_REQUEST_TEMPLATE/ y luego, el nombre de tu plantilla de solicitud de extracción. Por ejemplo,.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
. También puedes almacenar plantillas de solicitud de extracción múltiples en un subdirectorioPULL_REQUEST_TEMPLATE
dentro de la raíz o directoriosdocs/
. Para obtener más información, consulta "Acerca de la automatización para las propuestas y las solicitudes de extracción con parámetros de consulta ".
- Para que tus plantillas de solicitud de extracción sean visibles en el directorio raíz del repositorio, escribe el nombre de tu plantilla de solicitud de extracción. Por ejemplo,
-
En el cuerpo del nuevo archivo, agrega tu plantilla de solicitud de extracción. Puede incluir:
- Una referencia a una propuesta relacionada en tu repositorio.
- Una descripción de los cambios propuestos en la solicitud de extracción.
- @menciones de la persona o del equipo responsable de revisar los cambios propuestos.
-
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."
-
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."Las plantillas están a disposición de los colaboradores cuando se fusionan en la rama predeterminada del repositorio.
-
Click Propose new file.