commit

README.md

Escrever mensagens de commit claras e informativas é uma prática crucial para manter um histórico de código legível e compreensível. Aqui estão alguns exemplos de mensagens de commit para diferentes tipos de alterações em um projeto Python:

Exemplos de Mensagens de Commit:

1. Feature: Adição de funcionalidade para calcular a média de uma lista:

   Adiciona função calculate_media() para calcular a média de uma lista de números
   

2. Bugfix: Correção do erro ao tentar calcular média de lista vazia:

   Corrige bug em calculate_media() ao adicionar verificação para lista vazia
   

3. Teste: Adição de casos de teste para a função calculate_media:

   Adiciona testes unitários para a função calculate_media() cobrindo casos normais e lista vazia
   

4. Feature: Implementação de suporte para ordenação personalizada em função sort:

   Implementa suporte para chave de ordenação personalizada na função sort()
   

5. Bugfix: Resolve problema de ordenação incorreta ao usar função sort com chave:

   Corrige bug na função sort() ao garantir que a chave de ordenação seja aplicada corretamente
   

6. Teste: Adição de casos de teste para a ordenação personalizada:

   Adiciona testes para garantir a ordenação correta ao usar função sort() com chave personalizada
   

7. Refatoração: Melhora na eficiência da função de cálculo de média:

   Refatora calculate_media() para otimizar o desempenho usando um algoritmo mais eficiente
   

8. Documentação: Atualização na documentação para incluir a função calculate_media:

   Atualiza a documentação para incluir detalhes sobre a nova função calculate_media()
   

Dicas para Escrever Boas Mensagens de Commit:

1. Seja claro e conciso: Mantenha as mensagens curtas e diretas, explicando o que foi feito.

2. Use imperativos: Comece a mensagem com um verbo no imperativo, indicando a ação realizada.

3. Referencie issues: Se a alteração estiver relacionada a uma issue no sistema de controle de versão, faça referência a ela.

4. Divida alterações complexas: Se uma feature ou correção for grande, divida-a em commits menores e mais específicos.

5. Evite jargões desnecessários: Certifique-se de que suas mensagens sejam compreensíveis para outros membros da equipe.

6. Seja consistente: Mantenha um estilo consistente ao longo do projeto para facilitar a leitura do histórico.