Introdução

Nós gostamos de ter um histórico de projeto limpo. Nossa convenção de commits é inspirada por Conventional Commits, mas personalizada com gitmoji para torná-la mais visual e divertida.

Estrutura

A mensagem de commit deve ser estruturada da seguinte forma e em minúsculas:

<gitmoji> <tipo> <descrição> [(#<número do issue>)]
 
[corpo opcional]

[rodapé(s) opcional(is)]

Exemplo

📝 atualizar contribuidores da documentação

- Adicionar @jerembdn como um contribuinte
- Adicionar @younesbessa como um contribuinte

Co-autorado por: Younes Bessa <[email protected]>

Na maioria das vezes, uma linha simples é suficiente:

📝 atualizar contribuidores da documentação

Tipos

Nós usamos os seguintes tipos de commit:

O primeiro commit de um repositório usa initial, e uma tag de versão usa release:

🎉 commit inicial
🔖 lançamento @onruntime/translations v0.3.0

Descrição

O <tipo> é o verbo do assunto, e a descrição o completa. Lidos juntos, eles formam uma frase:

# Bom
📝 atualizar contribuidores da documentação

Então não comece a descrição com um segundo verbo. O tipo já é um, e o assunto acaba empilhando duas frases, que é o que um prefixo fix: leva a. Elimine o verbo e mantenha o que ele agia:

# Ruim
💄 melhorar a escala do gem no seu cartão
🐛 consertar o rodapé para não quebrar

# Bom
💄 melhorar o tamanho do gem no seu cartão
🐛 consertar o rodapé quebrando

Escreva no modo imperativo e em minúsculas:

# Ruim
📝 atualizado contribuidores da documentação

# Ruim
📝 Atualizar contribuidores da documentação

Número do Issue

Vincule commits a issues adicionando o número do issue:

📝 atualizar contribuidores da documentação (#123)

Corpo

Use o corpo para contexto e motivação:

📝 atualizar contribuidores da documentação

- Adicionar @jerembdn como um contribuinte
- Adicionar @younesbessa como um contribuinte

Co-autorado por: Younes Bessa <[email protected]>