Iniziare
Scopri la nostra convenzione di commit
Vogliamo avere una cronologia del progetto pulita. La nostra convenzione sui commit è ispirata da Conventional Commits ma personalizzata con gitmoji per renderla più visiva e divertente.
Struttura
Il messaggio del commit dovrebbe essere strutturato come segue e in minuscolo:
<gitmoji> <tipo> <descrizione> [(#<numero dell'issue>)]
[corpo facoltativo]
[footer(e) facoltativi]
Esempio
📝 aggiorna i contributori della documentazione
- Aggiungi @jerembdn come contributore
- Aggiungi @younesbessa come contributore
Co-authored-by: Younes Bessa <[email protected]>
Nella maggior parte dei casi, una semplice riga è sufficiente:
📝 aggiorna i contributori della documentazione
Tipi
Usiamo i seguenti tipi di commit:
| Tipo | Descrizione |
|---|---|
add | Aggiungi una nuova funzionalità |
fix | Correggi un bug |
improve | Migliora qualcosa |
update | Aggiorna qualcosa |
remove | Rimuovi qualcosa |
refactor | Rifattorizza qualcosa |
rename | Rinomina qualcosa |
move | Sposta un file o una cartella |
upgrade | Aggiorna le dipendenze |
downgrade | Downgrada le dipendenze |
initial | Commit iniziale di un repository |
release | Rilascio / tag di versione |
Il primo commit di un repository usa initial, e un tag di versione usa
release:
🎉 commit iniziale
🔖 rilascio @onruntime/translations v0.3.0
Descrizione
Il <tipo> è il verbo del soggetto, e la descrizione lo completa. Letti insieme, formano una frase:
# Buono
📝 aggiorna i contributori della documentazione
Quindi non aprire la descrizione con un secondo verbo. Il tipo è già uno, e
il soggetto finisce per accumulare due frasi, che è ciò che porta un prefisso fix:. Elimina il verbo e mantieni ciò su cui ha agito:
# Cattivo
💄 migliora riduci la gemma sulla sua scheda
🐛 correggi fermati per evitare che il footer si avvolga
# Buono
💄 migliora la dimensione della gemma sulla sua scheda
🐛 correggi il footer che si avvolge
Scrivilo in modo imperativo e minuscolo:
# Cattivo
📝 aggiornato i contributori della documentazione
# Cattivo
📝 Aggiorna i contributori della documentazione
Un Verbo Che È un Sostantivo
Alcune parole sono entrambe, e quella che intendi è il sostantivo: ✨ add open graph image
va bene. Quando si legge come un verbo, un articolo lo rende di nuovo un'espressione nominale:
✨ add a show more button.
Numero dell'Issue
Collega i commit alle issue aggiungendo il numero dell'issue:
📝 aggiorna i contributori della documentazione (#123)
Corpo
Usa il corpo per fornire contesto e motivazione:
📝 aggiorna i contributori della documentazione
- Aggiungi @jerembdn come contributore
- Aggiungi @younesbessa come contributore
Co-authored-by: Younes Bessa <[email protected]>
Un Commit, Un Scopo
Ogni commit dovrebbe rappresentare una singola modifica logica. Non mescolare modifiche non correlate.