Os commits devem ser escritos em inglês no seguinte formato:
<tipo>: <mensagem do commit> #número-da-issue
Exemplo:
feat: create sidebar component #01
Siga a especificação Conventional Commits para garantir consistência e compatibilidade com ferramentas de automação.
-
feat
Adiciona uma nova funcionalidade ao código.
(Relacionado ao MINOR do versionamento semântico). -
fix
Corrige um bug.
(Relacionado ao PATCH do versionamento semântico). -
docs
Mudanças apenas na documentação (ex: README).
(Sem alterações no código de produção). -
test
Adiciona ou modifica testes unitários.
(Sem alterações no código de produção). -
build
Mudanças relacionadas ao sistema de build ou dependências. -
perf
Alterações de código que melhoram a performance. -
style
Mudanças de formatação (espaços, ponto e vírgula, etc).
(Sem alterações funcionais). -
refactor
Refatoração de código que não corrige bug nem adiciona funcionalidade. -
chore
Tarefas de manutenção (ex: atualizar .gitignore, ajustes em ferramentas). -
ci
Mudanças na configuração de integração contínua. -
raw
Mudanças em configurações, dados, features ou parâmetros. -
cleanup
Remoção de código comentado ou desnecessário. -
remove
Exclusão de arquivos, diretórios ou funcionalidades obsoletas.
O título deve seguir o padrão do commit final gerado pela conclusão da Issue.
Os titulos devem ser escritos em inglês no seguinte formato:
<Classificação>:<título da Issue>
Exemplo: FEAT: Create sidebar component
Resumo: Apresente brevemente o objetivo daquela tarefa.
Descreva o que precisa ser feito ou corrigido, em detalhes de maneira clara.
- A descrição deve ser feita em inglês.
-
Assignees (responsável pela realização da Issue)
-
Label (legenda relacionada ao responsável da Issue):
FRONTEND|SVG|BACKEND|DESIGN|DOCS| -
Priority (prioridade para a realização da Issue):
HIGH|MEDIUM|LOW -
Status (Fase de desenvolvimento da Issue):
Backlog|Ready|In progress|Done
O título deve seguir o padrão do commit principal realizado durante a implementação.
Os títulos devem ser escritos em inglês no seguinte formato:
<Classificação>:<descrição do Pull Request>
Resumo: Apresente uma descrição breve sobre o propósito e impacto do Pull Request.
Detalhe as alterações realizadas de forma clara e objetiva:
- Funcionalidades implementadas
- Bugs corrigidos
- Melhorias de código
- Refatorações
A descrição deve ser feita em inglês.
- Reviewers: (_pessoas responsáveis pela revisão das alterações realizas)
- Assignees: (pessoas responsáveis pelas alterações realizadas)
- Label: (categoria relacionada às mudanças realizadas):
FRONTENDSVGBACKENDDESIGNDOCS
- Selecione a aba
Pull requestsem seu repositório:
- Após isso, selecione a branch de onde você deseja realizar o pull para a branch que você realizará o push:
- No exemplo estamos realizando o pull da branch
add-badges-to-readmepara a branchmain. - Ou seja, comparando os arquivos de
add-badges-to-readmecom os damain.
- Depois disso, adicione as propriedades desejada em seu Pull Request
- Neste exemplo, foi adicionado propriedade aos campos
Reviwers,Assignees,LabelseProjects.
- Após a aprovação dos usuários predefinidos como
Reviwers, confirme omergedas branchs e oPull request estará concluído.
.png)
.png)
.png)
.png)