Pull Requests

¿Por qué usar esta característica?

• Ahorrar tiempo: Genera automáticamente descripciones detalladas de PR basadas en tus cambios.
• Mantener consistencia: Asegura que todos los PRs sigan un formato consistente.
• Mejorar la colaboración: Proporciona contexto claro a los revisores con descripciones bien estructuradas.
• Optimizar el flujo de trabajo: Crea PRs sin salir de tu IDE.

Cómo funciona

Bob analiza los cambios de tu rama, el historial de commits y el nombre de la rama para entender el propósito y alcance de tu trabajo. Luego genera un título de PR significativo y una descripción detallada que resume tus cambios, facilitando a los revisores entender el contexto y propósito de tu PR. Después de la generación, puedes revisar y editar la descripción del PR antes de enviarlo.

El proceso de generación de PR es interactivo, permitiéndote seleccionar la rama de destino y el repositorio remoto antes de crear el PR.

Comenzar

Requisitos previos

• Tus cambios deben estar confirmados en una rama.
• Debes tener acceso de push al repositorio remoto.

Uso básico

Puedes elegir entre 3 opciones para iniciar un flujo de PR:

• Haz clic en el ícono de PR en el panel de Control de Código Fuente.
• Usa la Paleta de Comandos (Cmd + Shift + P en Mac, Ctrl + Shift + P en Windows/Linux) y busca "Bob: Generate PR".
• Escribe /create-pr en la interfaz de chat de Bob.

Bob te guiará a través de los siguientes pasos:

1. Selecciona la rama base en la que deseas fusionar. Bob sugerirá las tres ramas más probables.
2. Selecciona el repositorio remoto si tienes múltiples remotos.
3. Revisa la descripción y el título del PR generados.
4. Crea el PR.
5. Recibe el enlace al PR recién creado en tu chat.

Usar plantillas de descripción de PR

Bob detecta y usa automáticamente las plantillas de PR existentes de tu proyecto al generar descripciones de Pull Request. Esto asegura que tus PRs sean consistentes con los estándares establecidos de tu equipo. Si Bob detecta múltiples plantillas de PR en tu proyecto, puedes seleccionar qué plantilla aplicar a tu Pull Request.

Detección de plantillas

Bob busca plantillas de PR en las siguientes ubicaciones relativas a la raíz de tu proyecto:

1. ${cwd}/pull_request_template.md
2. ${cwd}/docs/pull_request_template.md
3. ${cwd}/.github/pull_request_template.md
4. ${cwd}/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
5. ${cwd}/PULL_REQUEST_TEMPLATE/pull_request_template.md
6. ${cwd}/docs/PULL_REQUEST_TEMPLATE/pull_request_template.md

Si Bob encuentra múltiples plantillas, Bob pedirá al usuario que seleccione qué plantilla usar para la descripción del PR.

Plantilla predeterminada

Si no se encuentra ninguna plantilla en tu proyecto, Bob usa una plantilla integrada que incluye:

• Un título descriptivo derivado del nombre de tu rama
• Un resumen de los cambios
• Detalles importantes de implementación
• Información de pruebas
• Cualquier enlace o referencia relevante

Editar la descripción generada

Después de generar la descripción del PR, Bob la muestra directamente en el chat. Entonces puedes:

• Confirmar y continuar: Aprueba la descripción tal como está para continuar con la creación del PR.
• Solicitar cambios: Escribe tu comentario en el chat y Bob regenerará la descripción según tu aportación. Puedes iterar tantas veces como necesites antes de confirmar.

Personalizar plantillas

Para obtener los mejores resultados con la generación de PR de Bob:

• Usa encabezados de sección claros en tus plantillas (por ejemplo, ## Resumen, ## Cambios)
• Incluye texto de marcador de posición que proporcione contexto (por ejemplo, <!-- Describe el propósito de este PR -->)
• Considera agregar secciones para instrucciones de prueba y problemas relacionados

Consejos y mejores prácticas

• Usa nombres de rama descriptivos para ayudar a Bob a generar descripciones de PR más precisas.
• Revisa y edita la descripción generada antes de crear el PR.