Skip to main content

Template de Pull Request

Los proyectos Open Source en Bancolombia promueven la colaboración y la transparencia en el desarrollo de software. Para facilitar la revisión y aprobación de cambios, se utiliza una plantilla estándar para las solicitudes de Pull Request (PR). Se define como lineamiento para mantener un orden y estructura dentro de nuestra cmunidad.

Esta plantilla, ubicada en el archivo .github/pull_request_template.yaml, asegura que cada PR contenga la información necesaria para una evaluación efectiva.

Estructura de la Plantilla​

La plantilla de PR consta de dos secciones principales:

  1. Descripción de los Cambios: Esta sección, en formato de área de texto, es obligatoria y solicita una descripción concisa de los cambios introducidos en el PR. Se espera que el desarrollador explique qué hace el PR y cuál es su propósito.

  2. Issues Relacionados: Esta sección, en formato de entrada de texto, permite al desarrollador especificar los issues que el PR resuelve. Se utiliza una sintaxis específica (por ejemplo, resolve #123) para vincular el PR con los issues correspondientes. Esto permite que los issues se cierren automáticamente una vez que el PR sea aceptado y fusionado.

Plantilla​

Plantilla_PR

Uso de la Plantilla​

Al crear un nuevo Pull Request en un proyecto Open Source, la plantilla se cargará automáticamente. Asegúrate de completar ambas secciones de la plantilla de manera clara y concisa antes de enviar el PR para su revisión.

Beneficios del uso de la Plantilla​

La utilización de esta plantilla estándar para los PRs ofrece varios beneficios:

  • Claridad y Contexto: Asegura que cada PR incluya una descripción clara de los cambios, lo que facilita la revisión por parte de otros miembros del equipo.
  • Trazabilidad: Permite vincular los PRs con los issues que resuelven, mejorando la trazabilidad y el seguimiento del progreso del proyecto.
  • Automatización: La sintaxis específica para vincular issues permite cerrarlos automáticamente al fusionar el PR, ahorrando tiempo y esfuerzo.
  • Consistencia: Promueve la uniformidad en la presentación de los PRs, facilitando su revisión y comprensión.