Aumente sua reputação no Github com mensagens de compromisso adequadas

Em vez de escrever mensagens git commit de uma linha com o commit -m opção, neste artigo aprenda como escrever mensagens de confirmação adequadas. Uma mensagem de commit adequada é importante, pois permite que outros vejam exatamente o que você modificou, tornando seu projeto mais fácil para outros acompanharem ajudando a aumentar sua exposição ao código aberto comunidade.

Escreva uma mensagem de compromisso adequada

Em vez de incluir a mensagem de confirmação no comando do terminal, abra o seu editor de texto para um arquivo em branco. A mensagem deve estar de acordo com o seguinte formato:

• A primeira linha é o título, resumindo todo o commit.
• Após uma linha em branco, a próxima linha ou várias linhas devem ser qualquer descrição legível necessária para o commit. Isso pode durar o tempo desejado.
  instagram viewer
• Todas as linhas a seguir devem resumir as alterações exatas feitas no código em tal formato:
  • Nome do arquivo: Linha # - Breve descrição da modificação.

Exemplo de mensagem de confirmação

Abaixo mostra um exemplo de mensagem de confirmação:

Adicionado suporte Docker, novo recurso is_unique, além de correção de bug.
Adicionado suporte para docker-compose e instruções de instalação atualizadas conforme necessário. Também incluiu um novo recurso dentro da função check_order () para verificar se há exclusividade e corrigiu um pequeno bug ao criar slugs de produto.
src / somedir / library.py: 381 - Adicionado parâmetro 'is_unique' à função check_order ().
src / products.py: 194 - Corrigido bug ao criar slug de produto.
docker-compose.yml - Arquivo docker-compose adicionado.
docs / install.md - Guia de instalação atualizado para incluir como instalar via Docker.

Mensagem de compromisso

Ao fazer um commit agora, em vez de usar o -m mensagem, use o--Arquivo opção. Por exemplo, se o nome do arquivo da sua mensagem de confirmação for commit.txt, você executaria o comando:

git commit --file commit.txt

Isso é tudo que há para fazer! Esperamos que isso ajude você a fornecer mensagens de commit mais padronizadas e claras para seus seguidores, ajudando seu projeto a ganhar exposição e ajudando o Código aberto comunidade crescer.

Crédito da imagem: Caleb White /Unsplash