Git: agregar un mensaje dedicado

Como muchos programadores han descubierto por las malas, es extremadamente importante agregar documentación para que pueda realizar fácilmente modificaciones en su código, solucionar problemas, pasar a otros, etc. Eso no tiene sentido ahora porque su código ahora tiene sentido para darle significado en 6 meses (o incluso semanas, en realidad). Probablemente esté acostumbrado a documentar su código real, pero esta misma práctica también debe seguirse con sus promesas de control de versiones.

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

Mientras ve un repositorio en GitHub, es posible que haya notado los mensajes junto a un archivo o carpeta:

Estos mensajes generalmente se agregan al repositorio en el momento en que realiza el compromiso, aunque también puede recuperar los mensajes de compromiso de forma retroactiva.

En GitHub, el mensaje está al lado del archivo o carpeta del último compromiso donde se cambió ese archivo / carpeta. Así que no todos son necesariamente de la última promesa. De lo contrario, no sería muy útil si GitHub mostrara el mismo mensaje de compromiso del último compromiso para cada archivo.

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

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

Mensajes en línea

No siempre se puede describir un cambio complejo con un breve comentario de una línea. Un aspecto interesante de esto -m Un banner es que puede agregar varios elementos a su mensaje utilizando el -m múltiples banderas iguales commit orden:

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

Estos mensajes múltiples aparecerán en la promesa resultante:

My Changes
- Fixed a critical bug
- Probably added more bugs

Otra opción, que depende del shell que esté utilizando, es ingresar una comilla simple o una comilla doble y presionar Enter, sin cerrar la cita. Esto funciona bien en Bash, que no ingresa el pedido hasta que cierra la cotización:

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

Y finalmente, no tienes el -m bandera en absoluto. Si ignora esta bandera, Git abrirá automáticamente un editor de texto para ingresarlo en el mensaje de compromiso.

.