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

gurinho

Em vez de escrever mensagens git commit de uma linha com a opção commit -m , neste artigo aprenda como escrever mensagens de commit 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 à comunidade de código aberto.

Escreva uma mensagem de compromisso adequada

Em vez de incluir a mensagem de confirmação no comando do terminal, abra seu editor de texto favorito em 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.
  • 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:

 
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.

Mensagem de compromisso

Ao fazer um commit agora, ao invés de usar a mensagem -m , use a opção –file . 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 a comunidade de código aberto a crescer.

Crédito da imagem: Caleb White / Unsplash