DEV Community

Cover image for Convención de mensajes para tus commits en Git que puedes emplear en tu proyecto
jesusfhohs
jesusfhohs

Posted on • Updated on

Convención de mensajes para tus commits en Git que puedes emplear en tu proyecto

Hello! ☺️ ✌️

Esta es una sugerencia de mensajes para tus commits en Git, basada en convenciones o estándares ocupados actualmente para llevar un mejor control y vista de los mismos, cabe destacar que a si mismo es un conjunto de diferentes fuentes, adecuado a mi experiencia de trabajo, de esta manera se puede navegar de una manera más fluida entre el historial de Git.

Formato del mensaje:

<type>(<scope>): <subject>
<body>
<footer>

Donde:

<type>

Es el tipo de commit que haremos, las descripciones recomendadas para este punto son:

  • feat: (feature) Se agrega una nueva característica ó se realiza alguna actualización a un feature que ya se había realizado y no necesariamente sea arreglar un bug
  • fix: Se corrige un bug
  • refactor: Refactorización
  • build: Cambios relacionados con dependencias a ocupar (como: npm related/ o dependencias externas o bien en caso de que se generen bundles de producción llevar el control de los archivos que cambien)
  • chore: Cambios que el usuario no verá, relacionados con configuraciones de git, o alguna herramienta que se esté ocupando en modo desarrollo (ejemplo: cambios a .gitignore o configuración en .prettierrc)
  • docs: Se hacen cambios a los archivos de documentación como al README
  • style: Principalmente cuando se realizan cambios de vista como formato, comas y puntos faltantes, etc. que no tenga cambios en el código.

<scope> [opcional]

<subject>

Preferentemente no debe contener mas de 50 caracteres, debe iniciar con una letra mayúscula y no terminar con un punto.

Se debe de ser imperativo al momento de redactar nuestro commit (como por ejemplo usar change en lugar de "changed" o "changes") y a su vez se tiene que ser objetivos en lo que se realiza con ese commit, posteriormente será mejor acostumbrarnos a escribirlos en Inglés esto sería una mejor práctica que podemos tener en nuestros commits.

<body> [opcional]

No todos los commits requieren de un cuerpo, por eso es opcional y se usan en caso de que el commit requiera una explicación amplia y/o contexto.

<footer> [opcional]

El pie también es opcional, pero este es usado para el seguimiento de los IDs con incidencias (Como de Jira o algún Id con referencia de un sprint asignado)

Ejemplo:

feat: Summarize changes, around 50 characters or less

Wrap it to about 72 characters or less

Closes #12
Enter fullscreen mode Exit fullscreen mode

¿Cómo quedaría el commit haciéndolo en Git?

git commit -am "feat: Summarize changes, around 50 characters or less" -m "Wrap it to about 72 characters or less" -m "Closes #12"

Enter fullscreen mode Exit fullscreen mode

(considerando que -am lo estoy usando por que se que mis archivos ya se encuentran en el stage)

En caso de ser un commit corto, sin body y no se requiere ser tan específico, pero si hacer la referencia al Id se podría poner de manera directa, algo como:

git commit -am "feat: Summarize changes, around 50 characters or less Closes #12"

Enter fullscreen mode Exit fullscreen mode

🙋 Por ultimo, recomiendo no abusar del "git add ." cuando en todo caso se tiene que separar el commit, en algunas ocasiones tal vez puedas agregar al stage archivos en específico como:

git add  index.html example.hmtl
Enter fullscreen mode Exit fullscreen mode

o tal vez se necesiten agregar todos los archivos js que se modificaron como:

git add js/*.js
Enter fullscreen mode Exit fullscreen mode

(considerando obviamente que se agregarán los que están en la carpeta donde estás ubicado o la que se indique como en el ejemplo)

o tal vez se necesiten agregar un directorio completo:

git add css/
Enter fullscreen mode Exit fullscreen mode

Para que de esta manera se tenga un mayor control en como realizamos nuestros commits.

Visualizando 👀👀

Para verlo de una manera más práctica, a través de un "git log" se pueden agregar características tales como "git log --graph", sin embargo aun sigue mostrándose información y espacios que tal vez al momento de visualizarlo no son necesarios dejo un formato que ocupo para visualizarlo de una manera más compacta:


git log --graph --abbrev-commit --decorate --format=format:'%C(bold blue)%h%C(reset) - %C(bold green)(%ar)%C(reset) %C(white)%s%C(reset) %C(dim blue)- %an%C(reset)%C(bold yellow)%d%C(reset)' --all

Enter fullscreen mode Exit fullscreen mode

Al momento de mostrarlo da el resultado en una sola línea por commit
Git log oneline

Pero, ¿Qué pasa si se requiere ver todo el mensaje tanto del body y footer, como en los ejemplos anteriores?, solamente cambiaremos dentro de nuestra instrucción "%s% por %B%

git log --graph --decorate --format=format:'%C(bold blue)%h%C(reset) - %C(bold green)(%ar)%C(reset) %C(white)%B %C(reset) %C(dim #29F914)- %an%C(reset)%C(bold yellow)%d%C(reset)' --all
Enter fullscreen mode Exit fullscreen mode

Mostrando así el body completo de nuestro commit

Git log multiline

Y bien... para no escribirlos o copiarlos y pegarlos siempre... les podemos agregar un alias en git para que así los consultemos rápidamente:

git config --global alias.lg "log --graph --abbrev-commit --decorate --format=format:'%C(bold blue)%h%C(reset) - %C(bold green)(%ar)%C(reset) %C(white)%s%C(reset) %C(dim blue)- %an%C(reset)%C(bold yellow)%d%C(reset)' --all"

git config --global alias.lgml "log --graph --decorate --format=format:'%C(bold blue)%h%C(reset) - %C(bold green)(%ar)%C(reset) %C(white)%B %C(reset) %C(blink cyan)- %an%C(reset)%C(bold yellow)%d%C(reset)' --all"
Enter fullscreen mode Exit fullscreen mode

De esta manera los podemos ejecutar como "git lg" ó "git lgml" teniendo los mismos resultados respectivamente.

Referencias

Karma Git Commit Msg
Chris.beams
https://www.conventionalcommits.org/en/v1.0.0/
https://git-scm.com/docs/git-log

Discussion (0)