Versions Compared

Version Old Version 4 New Version 5
Changes made by

Alfredo Bernal

Alfredo Bernal

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Un pequeño cambio en la forma que redactamos los mensajes al momento de hacer nuestros commit nos puede facilitar muchas cosas, desde el mantenimiento al código al ser más fácil identificar dónde/cuándo se realizo algún cambio, hasta la preparación de los despliegues al tener referencia de los Jiras trabajados.


Info
titleMensaje claro y descriptivo

Es importante recalcar que lo principal es lograr ser descriptivos en los mensajes de cada commit, ser claros al redactar los cambios realizados, tratando de contestar las siguientes preguntas.

  • ¿Qué se hizo?
  • ¿Por qué se hizo?
  • ¿Dónde se hizo?


...

Code Block
titleFormato
<tipo><opcional: símbolo ! que indica un cambio que puede afectar varias u otras funcionalidades>: <titulo>. <JIRA> (entremáximo 50 y 70 caracteres)

<resumen de las tareas realizadas, redactadas en tiempo presente> (sin límite de caracteres)

refs: <JIRA> (En caso de tener más de un JIRA involucrado, es posible realizar la separación de los JIRAS mediante ",")

<opcional: "BREAKING CHANGE" solo usar en conjunto con el símbolo ! de la primera línea>

...

Code Block
titleEjemplo
feat: Agregar funcionalidad. PSA-12345

-
Se agrega Controller/Request/Service para una funcionalidad determinada.

refs: PSA-12345

Más tipos

  • feat: nuevas funcionalidades para el usuario, no funcionalidades que sirven para el equipo de desarrollo.
  • fix: corrección de errores en la aplicación de cara al usuario, no correcciones que impliquen la construcción y/o distribución de los artefactos a desplegar
  • docs: cambios en la documentación
  • style: formateo del código, que no impliquen cambios directos al código y sus funcionalidades
  • refactor: refactorización del código y sus funcionalidades, renombrar variables, renombrar clases, etc.
  • test: agregar tests, refactorizar tests, sin que se realicen cambios al código y sus funcionalidades (adding missing tests, refactoring tests; no production code change)
  • chore: agregar o actualizar funcionalidades que ayuden al equipo de desarrollo y ayuden a la construcción y/o distribución de los artefactos a desplegar

...

Code Block
titleMúltiples tareas realizadas del mismo tipo
fix: Agregar funcionalidad.
PSA-12345

-
Se agrega Controller.
-
Se agrega mapeo de un campo
-.
Se modifica serialización para mostrar nuevo campo.

refs: PSA-12345


Code Block
titleMúltiples tareas realizadas de distinto tipo
fix: Se corrige funcionalidad. PSA-12345

- Se corrige validación.

refs: PSA-12345

feat: Se agrega funcionalidad.
PSA-12345

- Se agrega Controller.

refs: PSA-12346

test: Se agregan Tests. PSA-12345

- Se agrega test de servicio

refs: PSA-12347


Info
titleImportante

Lo ideal es realizar un commit por cada tipo de cambio que se está realizando, pero si no se hace por separado, lo mejor sería diferenciarlo en el mensaje del commit.

...

Code Block
titleBreaking change
refactor!: Se refactoriza funcionalidad. PSA-12345

- Se refactoriza servicio cambiando su constructor y modificando métodos.

refs: PSA-12345

BREAKING CHANGE


Code Block
titleUna sola línea
style: Se actualiza imagen.
refs: PSA-12345

fix: Se corrige nombre de variable.
refs: PSA-12345

Referencias

https://www.conventionalcommits.org/en/v1.0.0/

...