Políticas de Commit
Histórico de Versão
| Data | Data Prevista de Revisão | Versão | Descrição | Autor | Revisor |
|---|---|---|---|---|---|
| 10/11/2024 | 10/11/2024 | 1.0 | Criação do Documento | João Victor C. Nobre | Lucas Sales |
Diretrizes para Nomenclatura e Realização de Commits
É recomendável realizar commits sempre que houver uma mudança significativa no projeto. Cada commit deve refletir uma alteração coesa, garantindo que as alterações subsequentes sejam distintas das anteriores. Isso facilita a rastreabilidade e a revisão do histórico de modificações.
Quando realizar commits?
- Frequência de commits: Realize commits com frequência para evitar grandes alterações acumuladas. Commits menores e mais constantes permitem uma melhor organização e compreensão das mudanças feitas.
- Tamanho dos commits: Cada commit deve ser uma unidade lógica de trabalho. Evite adicionar várias mudanças de diferentes escopos em um único commit. Isso ajuda a rastrear e revisar o que foi feito com mais clareza.
Como nomear commits?
- O nome de um commit deve ser claro e descritivo, explicando brevemente o que foi alterado. Um bom nome facilita a identificação do propósito de cada commit.
Exemplo de boas práticas:
- [fix]: Para correções, como ajustes em erros ou bugs. Exemplo: [fix] corrigir erro de digitação no cronograma.
- [new]: Para novos recursos ou funcionalidades. Exemplo: [new] adicionar novo módulo de autenticação.
- [upd]: Para atualizações em funcionalidades ou documentos já existentes. Exemplo: [upd] atualizar documentação do projeto.
Benefícios de realizar commits frequentemente:
- Facilidade de rastreamento: Menores mudanças são mais fáceis de revisar e reverter, caso necessário.
- Risco reduzido: Menos alterações significam menor risco de introduzir bugs ou problemas inesperados.
- Reversibilidade: Caso seja necessário desfazer uma mudança, commits menores permitem reverter apenas as alterações pertinentes, sem perder o progresso de outras áreas do projeto.
Ao seguir essas orientações, você contribuirá para um histórico de código mais organizado, compreensível e fácil de gerenciar.