Generador de mensajes de commit

Por qué un mensaje de commit merece una línea tan clara como el diff

Un buen mensaje de commit debería sonar como una línea que un futuro desarrollador acaba de leer en una hora tranquila de depuración y por fin puede dejar la taza. El Códice del Narrador evoca mensajes de commit arraigados en la tradición de claridad de convenciones, el romance de la depuración futura y el suave teatro de un repositorio que el equipo ha estado puliendo silenciosamente desde que se fusionó la última solicitud de extracción.

La forma de una línea de depuración futura

Los mensajes de commit se apoyan en los commits convencionales, el prefijo de tipo y la fonología de los repositorios modernos, con una cuidadosa atención al marcador de alcance o intención. Los mensajes de commit más memorables se leen como una sola línea en un CHANGELOG, el tipo de línea que un mantenedor subraya. Los escribas asocian un mensaje a un tipo o marcador de alcance, por lo que el resultado ya transmite la sensación de un equipo que ha estado puliendo silenciosamente la misma convención durante dos años.

Para flujos de trabajo de repositorio, escenas de desarrollo de mesa y fanfics de informes de PR

Crea un mensaje de confirmación para iniciar un capítulo ambientado en un IDE tranquilo, diseña un flujo de trabajo para una partida única de mesa, nombra una confirmación para una traducción de fans, llena una reunión diaria con voces creíbles, construye un linaje de mantenedores, da pie a un fanfic donde el error finalmente se cierra, o llena un informe de desarrollador con mensajes en los que un desarrollador senior confiaría.

Consejos de los escribas que extienden las diferencias

Empieza con el tipo antes del título. Un mensaje de confirmación real comienza con el tipo al que pertenece el cambio. Deja que la sílaba alcance. Los mensajes de confirmación deben ser lo suficientemente cortos como para caber en una sola línea. Combina claridad con intención. Los mejores mensajes son concisos y un poco explicativos. Confía en el marcador de diferencias. Un tipo, un ámbito, una intención anclan el mensaje. Mantén el mensaje breve. Los mantenedores responden con saludos concisos.

Considera antes de tirar los dados

• ¿De qué convención de commit proviene tu mensaje: Commits convencionales, Angular, Gitmoji, interno o propio?
• ¿Debe el mensaje parecer fix, feat, refactor, chore o docs, y coincide el tipo?
• ¿El mensaje estará garabateado en una PR, bordado en una camiseta o susurrado en un fanfic?
• ¿Debe el marcador de familia ser un tipo, un ámbito o una intención?
• ¿Estás escribiendo para flujos de trabajo de repositorio, desarrollo de mesa o fanfic, y se mantiene la diferencia?