Comentarios en: Cómo escribir un mensaje de commit de git

Por: maurom

maurom — Fri, 11 Sep 2015 21:08:49 +0000

Genial. Compro esta última forma que mencionas, que además asocia las reglas 5 y 7 en una sola. Entonces la pregunta para armar el título de un cambio pasa a ser la siguiente: “qué hace este commit?”

qué hace este commit? este commit… Remueve métodos obsoletos
qué hace este commit? este commit… Mezcla el pull request #123
qué hace este commit? este commit… Agrega el soporte para proxy servers

eventualmente, el “por qué se hace?” queda para la descripción, y el “cómo lo hace?” es el código mismo.
Abrazo!

Por: Tomas

Tomas — Thu, 10 Sep 2015 23:55:20 +0000

La regla 7 expresa claramente que dejemos de hacer nuestros algoritmos totalmente faltos de expresividad. Por ese lado, estuvo haciendo algunas lecturas de Clean Code, donde llevan al extremo la idea de que “El código en si mismo es la documentación”. De esta forma, no hay motivos para explicar el como en otro lado (Ni en comentarios dentro del código, ni mucho menos en el repositorio ni en el issue tracker).

Cuando necesitamos explicar el como en el commit, es porque la deuda técnica es mayor a lo tolerable.

Sobre la 5, me cuesta mucho, pero pienso que es lo que propones o agregar adelante un “Debe remover…”, “Debe mezclar…”, pero me suena mas forzado. La idea del “Se…” tampoco me gusta. Si tuviera que quedarme con una, usaría la primera, aunque no sean ordenes, son consecuencias de una acción. La otra:

de aplicarse, este commit… “Remueve métodos obsoletos”
de aplicarse, este commit… “Mezcla el pull request #123”

Pero las veo como alternativas, me parece que lo importante es “ “.

Por: maurom

maurom — Thu, 10 Sep 2015 18:20:33 +0000

Buen post! Si tuviera puntines te llevarías los diez. Yo he cometido innumerables veces las barbaridades que se mencionan en el artículo y lentamente (creo que) voy mejorando.
Puntualmente, la regla 7 es fundamental. La 4 tiene sentido, pero aún me cuesta acostumbrarme. Y para la 5, me cuesta pensarlo en español: el imperativo me suena mal…

de aplicarse, este commit… “Remover métodos obsoletos”?
de aplicarse, este commit… “Mezclar el pull request #123”?

Las siguientes quedan un poco mejor,

de aplicarse, este commit… “Removerá métodos obsoletos”?
de aplicarse, este commit… “Mezclará el pull request #123”?
o bien
al aplicar este commit… “Se remueven métodos obsoletos”?
al aplicar este commit… “Se mezcla el pull request #123”?

pero no son órdenes. Alguna alternativa más fina?