- Razones para escribir buenos mensajes de commit
- Los mensajes de commit consistentes y claros ayudan a que otros desarrolladores los entiendan más fácilmente
- Usar buenos mensajes de commit facilita depurar problemas en el código
- Los mensajes de commit de git bien redactados transmiten el contexto de los cambios a otros desarrolladores que trabajan en el proyecto y a tu yo del futuro
- Cómo escribir buenos mensajes de commit
- Indica al inicio el tipo de commit para mostrar de qué trata
- Escribe mensajes de commit detallados por consideración hacia los demás (usa el commit body)
- Usa un tono imperativo o de solicitud en el mensaje de commit
- Elimina la puntuación innecesaria
- Sigue la "convención de commits" definida por el equipo
- La convención de commits del equipo de producto de Infograb
- Agregan emojis según el tipo de commit para que sea fácil de identificar de un vistazo
- Para distinguir componentes, páginas y funciones, los componentes se escriben con mayúscula inicial, mientras que las páginas y funciones se escriben en minúsculas
- Usan el commit body para agregar detalles al commit
- Para mantener mensajes de commit concisos, abrevian la palabra "function" como "función"
2 comentarios
La parte de que los emojis mejoran la legibilidad realmente me cuesta mucho compartirla. Bueno, si fueran solo 3, quizá...
Este artículo también está bueno.
https://chris.beams.io/posts/git-commit/
https://item4.github.io/2016-11-01/How-to-Write-a-Git-Commit-Message/