Los mensajes de compromiso son un medio importante de comunicación entre los miembros del equipo.
Lo que más importa en el desarrollo de software en equipo es la comunicación. Los mensajes de compromiso son importantes medios de comunicación entre los miembros del equipo: su pasado y su futuro.
Al analizar el código o depurar, todos tenemos preguntas como:
- ¿Por qué es esto si aquí?
- ¿Quién olvidó actualizar la rama?
- ¿Qué impacto ha tenido este cambio?
- ¿Cómo puede este cambio arreglar o mejorar el código?
Con este fin, git-blame nos permite descubrir qué revisión fue la última en cambiar el archivo. Pero saber eso no es suficiente. Sería útil leer el mensaje de confirmación para comprender lo que realmente sucedió allí.
Necesitamos leer el mensaje para experimentar el valor real de un buen mensaje de compromiso y estar motivados para escribirlo.
Algunas mejores prácticas
Entonces, si la mayoría de sus confirmaciones de Git hasta ahora se han creado con algo como git commit -m "9000 — Bug fixes issue", la próxima vez pruebe esta guía:
-m
sg&
gt; / --message=
gt; flag t
Le da una mala mentalidad desde el principio, ya que sentirá que tiene que ajustar su mensaje de confirmación en el comando de la terminal, y hace que la confirmación se sienta más como un argumento único que como una página en la historia.
La primera línea debe tener siempre 50 caracteres o menos y debe ir seguida de una línea en blanco.Escribe un tiempo imperativo: "Corregir error". [ Agregar | Fijar | Eliminar | Actualización | Refactor ] La redacción coherente facilita el procesamiento mental de una lista de confirmaciones.
Descripción más larga envuelta en 72 caracteres.A menudo, un tema por sí solo es suficiente.Cuando no lo esté, agregue una línea en blanco (esto es importante) seguida de uno o más párrafos ajustados a 72 caracteres.
Esos párrafos deben explicar:
¿Por qué es necesario este cambio?
Esta respuesta explica qué esperar en la confirmación, lo que les permite identificar y señalar más fácilmente cambios no relacionados.
¿Cómo aborda el problema?
Describa, en un nivel alto, qué se hizo para afectar el cambio. Si su cambio es obvio, es posible que pueda omitir abordar esta pregunta.
¿Qué efectos secundarios tiene este cambio?
Esta es la pregunta más importante a responder, ya que puede señalar problemas en los que está haciendo demasiados cambios en una confirmación o rama. Una o dos viñetas para los cambios relacionados pueden estar bien, pero cinco o seis son probablemente indicadores de un compromiso que está haciendo demasiadas cosas.
# 50-character subject line## 72-character wrapped longer description. This should answer:## * Why was this change necessary?# * How does it address the problem?# * Are there any side effects?## Include a link to the ticket, if any.Cómo hacer tu vida más fácil
Es mucho para recordar, pero puede configurar una plantilla de mensaje de confirmación utilizando el commit.template
Configure Git para usar un archivo de plantilla (por ejemplo, .gitmessage), luego cree el archivo de plantilla con Vim:
git config --global commit.template ~/.gitmessagevim ~/.gitmessageCuando ejecutamos git commitsin el -mindicador de mensaje, el editor abrirá nuestra útil plantilla lista para usar:
# [Add/Fix/Remove/Update/Refactor/Document] [summary]# Why is it necessary? (Bug fix, feature, improvements?)-# How does the change address the issue? -# What side effects does this change have?-# Include a link to the ticket, if any.Las líneas comentadas no se incluyen en el mensaje final. Simplemente complete las líneas en blanco con texto y viñetas debajo de las indicaciones.
Seguimiento de incidencias en GitHub y Bitbucket tanto reconocen las palabras clave close, fixy resolveseguidos inmediatamente por el número de solicitud de emisión o de tracción.
Creo que Linus estaría muy feliz si no volviéramos a usarlo git commit -m "Fix bug"en un repositorio público :)
Puede realizar una búsqueda simple en el registro de git para un número de problema, por ejemplo, con git log --grep=JIRA-1234
También puede usar complementos como vim-fugitivepara vim o git lenspara vs code para acceder rápidamente a los mensajes de confirmación de git.
Pensamientos finales
Crear confirmaciones de Git limpias dice mucho sobre ti y puede ser una forma principal en la que las personas interactúen contigo en proyectos.
Con un poco de práctica, puede hacer que sus hábitos de compromiso sean un reflejo aún mejor de su mejor trabajo, un trabajo que evidentemente se crea con cuidado y orgullo.
Tu futuro, tú y tu equipo, te agradecerán tu previsión y verbosidad cuando corran git blamepara ver por qué ese condicional está ahí.
Si te ha gustado este artículo, aplaude, recomiéndalo y compártelo.