Mensagens de Commit
Por que as Mensagens de Commit São Importantes
Mensagens de commit são essenciais para compreender o histórico de um projeto. Mensagens claras e significativas ajudam colaboradores, desenvolvedores futuros e você a entender o propósito e o contexto de cada alteração. Um histórico de commits bem estruturado melhora a colaboração, simplifica a depuração e facilita o rastreamento de mudanças específicas na linha do tempo do projeto.
Anatomia de uma Boa Mensagem de Commit
1. Concisão e Clareza
Uma mensagem de commit deve ser concisa e direta. Ela deve transmitir claramente o propósito do commit em uma única linha. Evite ambiguidade e forneça informações suficientes para entender a alteração sem precisar analisar o código propriamente dito.
Bad: "Fixed a bug"
Good: "Fix issue with user authentication in login form"
2. Separe o Assunto do Corpo
Se forem necessários mais detalhes, separe o assunto do corpo da mensagem de commit com uma linha em branco. O assunto deve resumir a alteração, e o corpo pode fornecer contexto adicional, motivos para a alteração e qualquer informação relevante.
Veja um exemplo de mensagem de commit:
Subject: "Add validation for user email input"
Body: "This commit introduces email format validation to ensure
that users provide a valid email address when registering. It
helps improve the overall data integrity of the system."
Neste caso, execute o comando git commit sem a opção -m:
O editor de texto padrão do Git será aberto, onde é possível escrever uma mensagem de commit detalhada. Em seguida, é necessário salvar e sair do editor de texto de forma apropriada.
Vamos realizar outro commit em nosso repositório:
Aqui está o comando utilizado para modificar o arquivo de texto:
A mensagem de commit é a seguinte:
Se não for possível editar o arquivo, pressione a tecla i. Isso garante que você entre no modo de edição. Novamente, para salvar as alterações e sair do Vim, pressione a tecla Escape e duas letras Z maiúsculas.
Se você utiliza um editor de texto padrão diferente do Vim no terminal e encontrar dificuldades, é fácil encontrar na internet como salvar alterações e sair dele.
3. Use o Modo Imperativo
Escreva mensagens de commit no modo imperativo, transmitindo uma orientação clara para a alteração. Inicie o assunto com um verbo, como "Corrigir", "Adicionar" ou "Atualizar".
Bad: "Fixed the issue with the login form"
Good: "Fix issue with user authentication in login form"
Obrigado pelo seu feedback!
Pergunte à IA
Pergunte à IA
Pergunte o que quiser ou experimente uma das perguntas sugeridas para iniciar nosso bate-papo
Can you explain why using the imperative mood is important in commit messages?
What are some other examples of good commit messages?
How do I know if my commit message is clear enough?
Awesome!
Completion rate improved to 3.57Mensagens de Commit
Deslize para mostrar o menu
Por que as Mensagens de Commit São Importantes
Mensagens de commit são essenciais para compreender o histórico de um projeto. Mensagens claras e significativas ajudam colaboradores, desenvolvedores futuros e você a entender o propósito e o contexto de cada alteração. Um histórico de commits bem estruturado melhora a colaboração, simplifica a depuração e facilita o rastreamento de mudanças específicas na linha do tempo do projeto.
Anatomia de uma Boa Mensagem de Commit
1. Concisão e Clareza
Uma mensagem de commit deve ser concisa e direta. Ela deve transmitir claramente o propósito do commit em uma única linha. Evite ambiguidade e forneça informações suficientes para entender a alteração sem precisar analisar o código propriamente dito.
Bad: "Fixed a bug"
Good: "Fix issue with user authentication in login form"
2. Separe o Assunto do Corpo
Se forem necessários mais detalhes, separe o assunto do corpo da mensagem de commit com uma linha em branco. O assunto deve resumir a alteração, e o corpo pode fornecer contexto adicional, motivos para a alteração e qualquer informação relevante.
Veja um exemplo de mensagem de commit:
Subject: "Add validation for user email input"
Body: "This commit introduces email format validation to ensure
that users provide a valid email address when registering. It
helps improve the overall data integrity of the system."
Neste caso, execute o comando git commit sem a opção -m:
O editor de texto padrão do Git será aberto, onde é possível escrever uma mensagem de commit detalhada. Em seguida, é necessário salvar e sair do editor de texto de forma apropriada.
Vamos realizar outro commit em nosso repositório:
Aqui está o comando utilizado para modificar o arquivo de texto:
A mensagem de commit é a seguinte:
Se não for possível editar o arquivo, pressione a tecla i. Isso garante que você entre no modo de edição. Novamente, para salvar as alterações e sair do Vim, pressione a tecla Escape e duas letras Z maiúsculas.
Se você utiliza um editor de texto padrão diferente do Vim no terminal e encontrar dificuldades, é fácil encontrar na internet como salvar alterações e sair dele.
3. Use o Modo Imperativo
Escreva mensagens de commit no modo imperativo, transmitindo uma orientação clara para a alteração. Inicie o assunto com um verbo, como "Corrigir", "Adicionar" ou "Atualizar".
Bad: "Fixed the issue with the login form"
Good: "Fix issue with user authentication in login form"
Obrigado pelo seu feedback!
