Komma igång

Vi gillar att ha en ren projekt historia. Vår commits konvention är inspirerad av Conventional Commits men anpassad med gitmoji för att göra det mer visuellt och roligt.

Struktur

Commit-meddelandet ska struktureras enligt följande och i gemener:

<gitmoji> <typ> <beskrivning> [(#<ärendenummer>)]

[valfri kropp]

[valfri fot(er)]

Exempel

📝 uppdatera dokumentation bidragsgivare

- Lägg till @jerembdn som en bidragsgivare
- Lägg till @younesbessa som en bidragsgivare

Co-authored-by: Younes Bessa <[email protected]>

Mestadels räcker en enkel enradare:

📝 uppdatera dokumentation bidragsgivare

Typer

Vi använder följande commit-typer:

Den första commit av ett repository använder initial, och en versionsetikett använder release:

🎉 första commit
🔖 release @onruntime/translations v0.3.0

Beskrivning

<typ> är verbet av ämnet, och beskrivningen kompletterar det. Tillsammans gör de en mening:

# Bra
📝 uppdatera dokumentation bidragsgivare

Så öppna inte beskrivningen med ett andra verb. Typen är redan ett, och ämnet kommer att stapla två meningar, vilket är vad en fix: prefix leder till. Droppa verbet och behåll det som det agerade på:

# Dåligt
💄 förbättra skala ner stenen på sitt kort
🐛 fixa stoppa foten från att rulla

# Bra
💄 förbättra storleken på stenen på sitt kort
🐛 fixa fotens rullning

Skriv det i imperativ form och gemener:

# Dåligt
📝 uppdaterad dokumentation bidragsgivare

# Dåligt
📝 Uppdatera dokumentation bidragsgivare

Ärendenummer

Länka commits till ärenden genom att lägga till ärendenumret:

📝 uppdatera dokumentation bidragsgivare (#123)

Kropp

Använd kroppen för kontext och motivation:

📝 uppdatera dokumentation bidragsgivare

- Lägg till @jerembdn som en bidragsgivare
- Lägg till @younesbessa som en bidragsgivare

Co-authored-by: Younes Bessa <[email protected]>