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

En lugar de escribir mensajes de confirmación de git de una línea con cometer -m opció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, hacer que su proyecto sea más fácil para que otros lo sigan ayudando a aumentar su exposición al código abierto comunidad.

Escriba un mensaje de compromiso adecuado

En lugar de incluir el mensaje de confirmación en el comando de terminal, abra su favorito editor de texto a 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.
instagram viewer
• 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:

Se agregó compatibilidad con Docker, nueva función is_unique y corrección de errores.
Se agregó soporte para docker-compose e instrucciones de instalación actualizadas según sea necesario. También se incluyó una nueva característica dentro de la función check_order () para verificar la singularidad y se corrigió un pequeño error al crear slugs de productos.
src / somedir / library.py: 381 - Se agregó el parámetro 'is_unique' a la función check_order ().
src / products.py: 194 - Corregido error al crear slug de producto.
docker-compose.yml - Se agregó el archivo docker-compose.
docs / install.md: guía de instalación actualizada para incluir cómo instalar a través de Docker.

Confirmar mensaje

Al hacer una confirmación ahora, en lugar de usar el -metro mensaje, use el--expediente opción. Por ejemplo, si el nombre de archivo de su mensaje de confirmación es commit.txt, ejecutaría el comando:

git commit - archivo 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 fuente abierta la comunidad crece.

Crédito de la imagen: Caleb White /Unsplash