Pregunta Mensajes apropiados de compromiso


¿Para qué son los mensajes de compromiso? Siempre los he estado escribiendo como una explicación de lo que hice, pero recientemente comencé una discusión al respecto con un colega que escribe mensajes de compromiso explicando por qué lo hizo. ¿Cuál es el correcto o hay otra respuesta por completo?

NOTA: No tengo la menor idea de si hay una respuesta "correcta" para esto. Como tal, lo he etiquetado como wiki de la comunidad y no aceptaré una respuesta. Los votos a favor decidirán el ganador :)


5
2018-06-10 03:40


origen


Respuestas:


Como preferencia personal, puedo decir qué fue hecho mirando las diferencias en los archivos directamente. los por qué es lo que no puedo inferir con solo mirar los cambios reales.

Si los cambios son significativos o complicados, incluiría no solo el por qué, sino también una breve descripción de la cómo.


6
2018-06-10 03:45



Creo que ambos son útiles. Una descripción rápida de lo que cambió ("Agregar validación de longitud para AddUserForm") es más fácil que mirar un diff, especialmente si está navegando en múltiples commits. Por qué se realizó el cambio, qué error solucionó, etc. obviamente también es algo muy bueno de tener.


1
2018-06-10 03:46



Los mensajes de compromiso son lo que usted hace de ellos, pero cuando hay cientos de ellos para un archivo en particular, o miles para un proyecto, desea poder escanearlos buscando ciertos cambios o la naturaleza de los cambios. En efecto, son como comentarios de código, y deben ser lo más útiles posible, pero concisos y concisos. Tal vez sea mejor pensar en ellos como tweets: transmitir el máximo significado en un espacio corto.

Como alguien que trabajó en grandes bases de código que abarcan décadas, y también proyectos más pequeños que abarcan uno o dos años, no encontré nada más exasperante cuando combiné registros de commit que mensajes como "oops" o "error solucionado". Si corrigió un error, díganos cuál (un número de error, como mínimo). Todo es importante para los forenses inevitables en el futuro.


1



Uso el mensaje de compromiso como una resumen ejecutivo de qué fue cambiado.

El resumen ejecutivo es un documento [...] breve que resume [...] de forma tal que los lectores pueden familiarizarse rápidamente con una gran cantidad de material sin tener que leerlo todo.

los por qué está documentado en otro lugar: un sistema de seguimiento de problemas, documentación de requisitos, etc. También incluyo enlaces del mensaje de confirmación al por qué, y viceversa.


1