¿Cómo escribir buenos mensajes de confirmación en GitHub?

El control de versiones o el control de fuentes es la práctica de realizar un seguimiento de los cambios que ha realizado en el código del software. Los sistemas de control de versiones son las herramientas que ayudan a los equipos de software a administrar los cambios en su código fuente. El software de control de versiones realiza un seguimiento de cada modificación que realizó en el código en un tipo especial de base de datos. El software de control de versiones es la parte más importante de las prácticas modernas de los desarrolladores de software. Hay muchos software de control de versiones disponibles en el mercado, pero el software de control de versiones más utilizado es Git.

En Git , usamos el comando de confirmación para guardar los cambios en nuestro repositorio después de la preparación. En otras palabras, git commit crea una confirmación, que es como una instantánea de todo tu repositorio en un momento específico. Cuando realiza una confirmación, debe agregarle un mensaje de confirmación para que pueda ayudarlo a identificar una confirmación específica siempre que sea necesario en el futuro.

¿Cómo escribir un mensaje de confirmación con Git?

Hay dos métodos para escribir un mensaje de confirmación:

• método editor
• Método de línea de comandos

método editor 

Se usa cuando tiene que agregar una descripción larga, pero no se usa comúnmente cuando tenemos que agregar un mensaje de confirmación breve.

Para usar este método, ejecute el comando git commit sin opción y se abrirá el editor de texto predeterminado. En el editor que se abrió, la primera línea es el asunto que brinda una breve descripción sobre la confirmación y luego deja una línea en blanco después y todo lo que sigue a la línea en blanco sería una descripción extendida. También puede cambiar su editor predeterminado según su elección.

La sintaxis para el método del editor se proporciona a continuación:

git cometer

Entonces, este comando abrirá su editor predeterminado donde puede agregar un asunto y una breve descripción sobre ese compromiso. Puede agregar el asunto y el cuerpo de la confirmación de la siguiente manera:

Método  de línea de comandos

Es el método más utilizado en el que puede agregar un mensaje de confirmación con el comando git commit en una sola línea.

La sintaxis para el método de línea de comando se proporciona a continuación:

git commit -m “asunto” -m “descripción..”

Aquí la primera y segunda opción -m es asunto y descripción respectivamente.

¿Por qué deberíamos escribir buenos mensajes de confirmación?

Ya sea que esté trabajando en un proyecto personal o en un proyecto de equipo, es necesario escribir un buen mensaje de compromiso porque es la única forma de comunicar el contexto sobre un cambio a su compañero de equipo o a otros desarrolladores que están contribuyendo a su proyecto. Los buenos mensajes de compromiso también pueden ayudarlo a comprender fácilmente por qué realizó algunos cambios en el pasado. Los buenos mensajes de compromiso pueden desarrollar una gran comprensión que puede hacer que el desarrollo y la colaboración sean más eficientes.

¿Cómo escribir buenos mensajes de confirmación?

Hay muchas convenciones seguidas por diferentes desarrolladores y equipos para escribir un mensaje de confirmación, pero hay muchos consejos que pueden ayudarlo a seguir una mejor convención para escribir mensajes de confirmación.

Estos son algunos de los consejos que pueden ayudarlo a escribir buenos mensajes de confirmación: 

• Indique el tipo de confirmación en el asunto de los mensajes de confirmación. Debe especificar el tipo de compromiso en función de los cambios que haya realizado. Por ejemplo, si ha realizado cambios en la documentación, debe especificar su compromiso de la siguiente manera:

git commit -m «documentos actualizados ABC»

En el mensaje de confirmación anterior, ‘docs’ muestra el tipo de confirmación o muestra que se realizan cambios en la documentación. Del mismo modo, puede usar ‘arreglar’ para corregir errores, ‘estilo’ para actualizaciones relacionadas con el estilo y ‘prueba’ para probar cosas relacionadas.

• No uses signos de puntuación innecesarios. Algunos desarrolladores usan signos de puntuación en los mensajes de confirmación, esta no es una buena práctica porque a veces puede parecer muy poco profesional o feo. Por ejemplo, muchos desarrolladores no prestan atención a escribir mensajes de confirmación adecuados y simplemente agregan un texto aleatorio con muchos signos de puntuación. Puede echar un vistazo a estos tipos de mensajes de confirmación que se detallan a continuación:

git commit -m “agregado—!–!–¡¡Léame!!”

Puede notar que en el mensaje de confirmación anterior, hemos usado toneladas de signos de puntuación y esto hace que el mensaje de confirmación sea más feo y confuso. Por lo tanto, intente liberar los signos de puntuación de sus mensajes de confirmación.

• Utilice mayúsculas para el asunto y la descripción. No es necesario usar mayúsculas, pero generalmente es una buena práctica.
• Agregue una descripción para explicar qué cambios ha realizado y por qué los hizo
• No asuma que el revisor entenderá cuál era el problema original, asegúrese de agregarlo en el mensaje de confirmación.
• Hacer uso del modo imperativo en el sujeto.
• Sigue la convención definida por tu equipo

Lo más importante de un mensaje de confirmación es que debe ser claro y significativo. Escribir buenos mensajes de confirmación muestra cuán activo eres como colaborador.