LabEx
EntrarJunte-se

Adicionar um Modelo de Mensagem de Commit

Beginner

This tutorial is from open-source community. Access the source code

Introdução

Ao trabalhar em um projeto, é importante ter uma mensagem de commit consistente e informativa para cada alteração feita no código-base. Isso ajuda outros desenvolvedores a entender o propósito da alteração e facilita o rastreamento de bugs ou a reversão de alterações, se necessário. Neste laboratório, você aprenderá como configurar um modelo de mensagem de commit para um repositório Git.

Adicionar um Modelo de Mensagem de Commit

Sem um modelo de mensagem de commit, os desenvolvedores podem ser tentados a escrever mensagens de commit vagas ou pouco informativas, como "corrigido bug" ou "código atualizado". Isso dificulta que outros entendam o propósito da alteração e pode levar a confusão ou erros no futuro. Ao configurar um modelo de mensagem de commit, os desenvolvedores são incentivados a fornecer mensagens de commit mais detalhadas e informativas, o que pode melhorar a colaboração e a produtividade.

Para este laboratório, vamos usar o repositório de https://github.com/labex-labs/git-playground. Siga estas etapas para configurar um modelo de mensagem de commit para este repositório:

  1. Clone o repositório para sua máquina local usando o comando git clone https://github.com/labex-labs/git-playground.
  2. Navegue até o diretório do repositório usando o comando cd git-playground e configure sua conta do GitHub usando os comandos git config --global user.name "seu-nome-de-usuário" e git config --global user.email "seu-email".
  3. Crie um novo arquivo chamado commit-template no diretório do repositório usando o comando vim commit-template.
  4. Abra o arquivo commit-template em um editor de texto e adicione as seguintes linhas:
## <type>: <subject>

## <body>

## <footer>

#This creates a template with three sections, where "<type>" indicates the type of submission, such as "feat" or "fix", "<subject>" is a short #summary describing the content of the submission, "<body>" is a more detailed description, and "<footer>" can contain other metadata, such as the #associated issue number or other comments.
  1. Pressione Esc e digite o comando :wq, em seguida, pressione Enter para salvar suas alterações e sair do editor do arquivo commit-template.
  2. Use o comando git add commit-template para adicionar o arquivo commit-template à área de staging (staging area).
  3. Use o comando git config commit.template commit-template para definir o arquivo commit-template como o modelo de mensagem de commit para o repositório.
  4. Use o comando git commit para abrir o editor de mensagem de commit e observe que o editor de mensagem de commit agora contém o modelo de mensagem de commit que você criou na etapa 4.
  5. Pressione Esc e digite o comando :q, em seguida, pressione Enter para sair do editor de mensagem de commit.

Resumo

Neste laboratório, você aprendeu como configurar um modelo de mensagem de commit para um repositório Git. Ao usar um modelo de mensagem de commit, os desenvolvedores podem fornecer mensagens de commit mais detalhadas e informativas, o que pode melhorar a colaboração e a produtividade. Lembre-se de sempre escrever mensagens de commit claras e concisas para ajudar os outros a entender o propósito de suas alterações.