1.7 KiB
1.7 KiB
title | localeTitle |
---|---|
Writing Good Git Commit Messages | Escribir buenos mensajes de Git Commit |
- Separar sujeto del cuerpo con una línea en blanco.
- Limite la línea de asunto a 50 caracteres
- Capitalizar la línea de asunto
- No termine la línea de asunto con un punto
- Utilice el estado de ánimo imperativo en la línea de asunto
- Envuelve el cuerpo a 72 caracteres
- Usa el cuerpo para explicar qué y por qué frente a cómo
Una línea de asunto de git commit correctamente formada siempre debe poder completar la siguiente oración:
Si se aplica, esta confirmación será
<<your subject line here>>
Por ejemplo:
- Si se aplica, este compromiso Refactorizará el subsistema X para facilitar la lectura.
- Si se aplica, esta confirmación actualizará la documentación de inicio.
- Si se aplica, esta confirmación eliminará los métodos en desuso.
- Si se aplica, este commit lanzará la versión 1.0.0.
- Si se aplica, esta confirmación fusionará la solicitud de extracción # 123 del usuario / rama
Observe cómo esto no funciona para las otras formas no imperativas:
- Si se aplica, esta confirmación solucionará el error con Y
- Si se aplica, esta confirmación cambiará el comportamiento de X
- Si se aplica, esta confirmación tendrá más correcciones para las cosas rotas.
- Si se aplica, esta confirmación será dulce nuevos métodos API
Recuerde: el uso del imperativo es importante solo en la línea de asunto. Puedes relajar esta restricción cuando estás escribiendo el cuerpo.
Referencia: http://chris.beams.io/posts/git-commit