...
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 |
|---|
| title | Mensaje 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 |
|---|
|
<tipo><opcional: símbolo ! que indica un cambio que puede afectar varias u otras funcionalidades>: <titulo>. <JIRA> (entre 50 y 70 caracteres)
<resumen de las tareas realizadas, redactadas en tiempo presente> (sin límite de caracteres)
<opcional: "BREAKING CHANGE" solo usar en conjunto con el símbolo ! de la primera línea> |
...
| Code Block |
|---|
|
refactor!: Se refactoriza funcionalidad. PSA-12345
- Se refactoriza servicio cambiando su constructor y modificando métodos.
BREAKING CHANGE |
| Code Block |
|---|
|
style: Se actualiza imagen. PSA-12345
fix: Se corrige nombre de variable. PSA-12345 |
Referencias
https://www.conventionalcommits.org/en/v1.0.0/
...