Aumente su reputación en Github con mensajes de confirmación adecuados

Aranzulla de Los Pobres

En lugar de escribir mensajes de confirmación de git de una línea con la opción -m de confirmación , en este artículo aprenda a escribir mensajes de confirmación adecuados. Un mensaje de confirmación adecuado es importante, ya que permite que otros vean exactamente lo que ha modificado, lo que hace que su proyecto sea más fácil de seguir para otros, lo que ayuda a aumentar su exposición a la comunidad de código abierto.

Escriba un mensaje de compromiso adecuado

En lugar de incluir el mensaje de confirmación en el comando del terminal, abra su editor de texto favorito en un archivo en blanco. El mensaje debe ajustarse al siguiente formato:

  • La primera línea es el título, que resume toda la confirmación.
  • Después de una línea en blanco, la siguiente línea o varias líneas debe ser cualquier descripción legible necesaria para la confirmación. Esto puede ser tan largo como desee.
  • Todas las siguientes líneas deben resumir los cambios exactos realizados en el código en dicho formato:
    • Nombre de archivo: Línea # – Breve descripción de la modificación.

Ejemplo de mensaje de confirmación

A continuación se muestra un ejemplo de mensaje de confirmación:

 
Added Docker support, new is_unique feature, plus bug fix.
 Added support for docker-compose and updated installation instruction as necessary. Also included a new feature within check_order() function to check for uniqueness, and fixed small bug when creating product slugs.
 src/somedir/library.py:381 -- Added 'is_unique' parameter to the check_order() function.
 src/products.py:194 -- Fixed bug when creating product slug.
 docker-compose.yml -- Added docker-compose file.
 docs/install.md -- Updated installation guide to include how to install via Docker.

Confirmar mensaje

Cuando realice una confirmación ahora, en lugar de usar el mensaje -m , use la opción –file . Por ejemplo, si el nombre de archivo de su mensaje de confirmación es commit.txt, ejecutaría el comando:

 git commit --file commit.txt

¡Eso es todo al respecto! Esperamos que esto le ayude a proporcionar mensajes de compromiso más estandarizados y claros a sus seguidores, ayudando a que su proyecto gane exposición y ayude a que la comunidad de código abierto crezca.

Crédito de la imagen: Caleb White / Unsplash