Escribiendo buenos mensajes de commit
by Francho Joven
25 Sep 2015
. Comments
Una de las ventajas del pair programming es que se te acaban pegando los buenos vicios del compañero. Cuando empezamos con Spines, @leptom era muy estricto con los commits: hacía varios commits donde yo hubiera hecho uno solo y pensaba mucho el texto del mensaje.
Con el paso del tiempo entre todo el equipo hemos ido perfeccionando una regla que cumplimos a rajatabla y que me recuerda mucho al post que ha recomendado hoy @nestorsaceda.
Los mandamientos de Spines para escribir commits son:
- Haz commits atómicos. (Un olor para detectar esto es la cantidad de ficheros que vas a mandar, nosotros no solemos incluir mas de uno o dos por cada commit)
- Escribe el mensaje del commit en inglés
- Empieza en mayúsculas
- Escribe en presente (me gusta la regla de completar esta frase: If applied, this commit will your subject line here
- El subject (la primera línea) no debe tener más de 50 caracteres
- Si es una issue añade la coletilla con el id para que se cierre automáticamente en github
- Separado con una linea en blanco pon el enlace a la tarjeta de Trello en la que estas trabajando
- Si es necesario, debajo del link, puedes poner alguna explicación extra
Con esto estamos consiguiendo un log del proyecto muy claro que da gusto leer.
Y tú ¿qué reglas usas para escribir tus commits?