Git: agregar un mensaje de confirmación

Agregar documentación es importante para poder modificar fácilmente su código, solucionar problemas, pasárselo a otros, etc. En Git, hay algunas formas de documentar sus cambios.

Como muchos programadores han descubierto por las malas, agregar documentación es extremadamente importante para poder realizar fácilmente modificaciones a su código, solucionar problemas, pasarlo a otros, etc. El hecho de que su código tenga sentido ahora no significa que lo sea. Tendrá sentido para usted en 6 meses (o incluso una semana, en realidad). Probablemente esté acostumbrado a documentar su código real, pero esta misma práctica también debe seguirse con sus confirmaciones de control de versiones.

En Git, hay algunas formas de documentar sus cambios, pero en este breve artículo nos centraremos principalmente en cómo hacerlo para confirmaciones individuales.

Al ver un repositorio en GitHub, probablemente haya notado los mensajes junto a un archivo o carpeta:

git commit messages in github

Estos mensajes generalmente se agregan al repositorio en el momento en que realiza la confirmación, aunque también puede agregar mensajes de confirmación retroactivamente.

En GitHub, el mensaje junto al archivo o carpeta es de la última confirmación en la que cambió ese archivo/carpeta. Así que estos no son todos necesariamente del último compromiso. De lo contrario, no sería muy útil si GitHub mostrara el mismo mensaje de confirmación de la última confirmación para todos los archivos.

Para agregar este mensaje, debe especificar el indicador -m al ejecutar git commit. Su mensaje debe seguir inmediatamente a la bandera y estar entre comillas. Un ejemplo de esto se ve así:

1
$ git commit index.js -m "Fixed world-ending bug (#281)"

Mensajes de varias líneas

No siempre se puede describir un cambio complejo con un breve comentario de una sola línea. Una característica interesante del indicador -m es que puede agregar varios párrafos a su mensaje utilizando el indicador -m varias veces en el mismo comando commit:

1
$ git commit index.js -m "My Changes" -m "- Fixed a critical bug" -m "- Probably added more bugs"

Estos múltiples mensajes se verán así en la confirmación resultante:

1
2
3
My Changes
- Fixed a critical bug
- Probably added more bugs

Otra opción, que depende del shell que esté usando, es simplemente ingresar una comilla simple o doble y presionar [Enter]{.kbd}, sin cerrar la comilla. Esto funciona bien en Bash, que no ingresa el comando hasta que haya cerrado la cotización:

1
2
3
4
$ git commit index.js -m "My Changes
- Fixed a critical bug
- Probably added more bugs
"

Y finalmente, en realidad no necesitas usar el indicador -m en absoluto. Si omite este indicador, Git abrirá automáticamente un editor de texto para que ingrese el mensaje de confirmación. ón.

Licensed under CC BY-NC-SA 4.0