Pull Request Style Guide

Owned by Eduardo Martinez (Unlicensed)
Oct 27, 2022
3 min read

Responsables: @Jorge Luis Calleja Alvarado (Unlicensed) @Jose Napa @Oscar Benjamín Grande Gutierréz @Alberto Rubio @Erick Rosales (Unlicensed)

Solicitamos a los colaboradores de los proyectos de spin que envíen una solicitud de incorporación de cambios con sus cambios. Estas son nuestras expectativas para las solicitudes de extracción.

seguirlos acelerará el proceso de fusión de su código.

 

Lea y siga las pautas de contribución para el proyecto. Aquí hay capturas de pantalla de dónde podra ver un preview de un pull request

  • Hacer un nuevo branch.

    • Cree una rama separada para cada issue en el que esté trabajando. No realice cambios en la rama predeterminada (por ejemplo, master, qa, prod, dr o staging) de su bifurcación.

  • Commits Convencionales

    • Sigue los estándares propuestos por spin para poder empujar tu código

      • Define un tipo de acuerdo a la implementación [chore, docs, feature, bugfix, hotfix, refactor, revert, test].

      • Define un ámbito según corresponda el pod [POP-, DFSD-, HERC-, ACU-, ESC-, OR-, HYDRA-, LEO-, DRAC-, FEN-]

      • Agrega una descripción breve y clara especificando el contenido de tu implementación

      • Ejemplo: <tipo>(ámbito): <descripción>

  • Empuje su código lo antes posible.

  • Describe Your Pull Request

    • Use el formato especificado en la plantilla de solicitud de extracción para el repositorio. Rellene la plantilla por completo para obtener la máxima verbosidad.

      • Etiquete el número de tarea de jira reemplazando _jira task id_ e.g. POP-123.

      • Etiquete el link de la tarea de jira reemplazando _jira task link_ e.g. https://fintechdigital.atlassian.net/browse/POP-123 .

      • Lo que hace este PR, puede agregar gifs o capturas de pantalla para ayudar a los revisores a saber qué está pasando despues de **Description:**

      • Proporcione cualquier paso o información que pueda ayudar a replicar si es un error que está resolviendo después ⚠️ How can I replicate this `bug`:

      • Proporcione cualquier paso o información que pueda ayudar a probar su solución después de 🚀 Steps to test the fix:

      • Su Pull request es un nuevo feature, proporcione cualquier paso o información que pueda ayudar a probar después de 🚸 What steps should I follow to test this new feature?:

      • Complete el Checklist

  • Solicitar revisión

    • Una vez que su PR esté listo, elimine el "[WIP]" del título y/o cámbielo de un borrador de PR a un PR regular.

    • Si un revisor específico no se asigna automáticamente, solicite una revisión del mantenedor del proyecto y cualquier otra parte interesada manualmente (integrates de su equipo).

  • Incorporación de feedback

    • Si su PR recibe una revisión de "Cambios solicitados", deberá abordar los comentarios y actualizar su PR presionando a la misma sucursal. No es necesario cerrar el PR y abrir uno nuevo.

    • Asegúrese de volver a solicitar la revisión una vez que haya realizado cambios después de una revisión del código

    • Solicitar una nueva revisión deja en claro que abordó los cambios que se solicitaron y que está esperando a los mantenedores y no al revés.

  • Limite los cambios a sus archivos

    • Su solicitud de extracción no debe exceder los 14 archivos modificados para una revisión más rápida.

    • Cada archivo debe tener un máximo de 350 líneas de código.