Configurar una plantilla de mensaje de confirmación para repositorios Git

Introducción

🧑‍💻 ¿Nuevo en Git o LabEx? Te recomendamos comenzar con el curso Quick Start with Git.

Cuando se trabaja en un proyecto, es importante tener un mensaje de confirmación coherente e informativo para cada cambio realizado en la base de código. Esto ayuda a otros desarrolladores a entender el propósito del cambio y facilita la búsqueda de errores o la reversión de cambios si es necesario. En este laboratorio, aprenderás cómo configurar una plantilla de mensaje de confirmación para un repositorio Git.

Skills Graph

%%%%{init: {'theme':'neutral'}}%%%% flowchart RL git(("Git")) -.-> git/BasicOperationsGroup(["Basic Operations"]) git/BasicOperationsGroup -.-> git/commit("Create Commit") subgraph Lab Skills git/commit -.-> lab-12710{{"Agregar una plantilla de mensaje de confirmación"}} end

Agregar una plantilla de mensaje de confirmación

Sin una plantilla de mensaje de confirmación, los desarrolladores pueden tener la tentación de escribir mensajes de confirmación vagos o sin información, como "arreglado error" o "código actualizado". Esto dificulta que otros entiendan el propósito del cambio y puede llevar a confusión o errores más adelante. Al configurar una plantilla de mensaje de confirmación, se anima a los desarrolladores a proporcionar mensajes de confirmación más detallados e informativos, lo que puede mejorar la colaboración y la productividad.

Para este laboratorio, usemos el repositorio de https://github.com/labex-labs/git-playground. Siga estos pasos para configurar una plantilla de mensaje de confirmación para este repositorio:

Clone el repositorio en su máquina local usando el comando git clone https://github.com/labex-labs/git-playground.
Navegue hasta el directorio del repositorio usando el comando cd git-playground y configure su cuenta de GitHub usando los comandos git config --global user.name "su-nombre-de-usuario" y git config --global user.email "su-correo-electrónico".
Cree un nuevo archivo llamado commit-template en el directorio del repositorio usando el comando vim commit-template.
Abra el archivo commit-template en un editor de texto y agregue las siguientes líneas:

## <tipo>: <asunto>

## <cuerpo>

## <pie de página>

## Esto crea una plantilla con tres secciones, donde "<tipo>" indica el tipo de envío, como "func" o "arreglo", "<asunto>" es un resumen corto que describe el contenido del envío, "<cuerpo>" es una descripción más detallada y "<pie de página>" puede contener otros metadatos, como el número de problema asociado o otros comentarios.

Presione Esc y escriba el comando :wq, luego presione Enter para guardar sus cambios y salir del editor de archivos commit-template.
Use el comando git add commit-template para agregar los archivos commit-template a la área de preparación.
Use el comando git config commit.template commit-template para establecer el archivo commit-template como la plantilla de mensaje de confirmación para el repositorio.
Use el comando git commit para abrir el editor de mensaje de confirmación y observe que el editor de mensaje de confirmación ahora contiene la plantilla de mensaje de confirmación que creó en el paso 4.
Presione Esc y escriba el comando :q, luego presione Enter para salir del editor de mensaje de confirmación.

Resumen

En este laboratorio, aprendiste cómo configurar una plantilla de mensaje de confirmación para un repositorio Git. Al usar una plantilla de mensaje de confirmación, los desarrolladores pueden proporcionar mensajes de confirmación más detallados e informativos, lo que puede mejorar la colaboración y la productividad. Recuerda siempre escribir mensajes de confirmación claros y concisos para ayudar a otros a entender el propósito de tus cambios.