Guia de Commit
Guia de commit
Esse guia tem o objetivo de definir um padrão para os commits no projeto.
Tipos
Os commits serão separados por funcionalidades, devendo respeitar o formato abaixo:
-
:bulb: quando adicionar nova funcionalidade
-
:pencil: quando escrever documentação
-
:repeat: quando alguma alteração for feita
-
:racehorse: refatoração ou otimização
-
:bug: quando consertar um bug
-
:fire: quando remover código ou arquivos
Grupos
Commits em grupo devem ter ser adicionado a mensagem do commit:
Co-authored-by: 'user do membro' 'email do membro'
Mensagem
A mensagem de commit deve ser clara e sucinta, respeitando o formato abaixo:
-
Escrita em português
-
Verbos no gerúndio
-
Deve possuir um tipo e o objetivo do commit
Exemplos
Commit de um único autor
:bulb: Adicionando crud de usuário
Commit em grupo
:bug: Consertando crud de usuário
Co-authored-by: CibeleG cibelegoudinho13@gmail.com
Histórico de versão
Data | Versão | Descrição | Autor(es) |
---|---|---|---|
09/04/2024 | 1.0 | Criação do Documento | Cibele Freitas Goudinho |