Aan de slag

We houden van een schone projectgeschiedenis. Onze commitconventie is geïnspireerd door Conventional Commits maar aangepast met gitmoji om het visueler en leuker te maken.

Structuur

De commitboodschap moet als volgt gestructureerd zijn en in kleine letters:

<gitmoji> <type> <description> [(#<issue nummer>)]

[optioneel body]

[optionele footer(s)]

Voorbeeld

📝 update documentatie bijdragers

- Voeg @jerembdn toe als bijdrager
- Voeg @younesbessa toe als bijdrager

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

De meeste tijd is een simpele oneliner genoeg:

📝 update documentatie bijdragers

Types

We gebruiken de volgende commit types:

De eerste commit van een repository gebruikt initial, en een versie tag gebruikt release:

🎉 initiële commit
🔖 release @onruntime/translations v0.3.0

Beschrijving

De <type> is het werkwoord van het onderwerp, en de beschrijving maakt het compleet. Samen vormen ze één zin:

# Goed
📝 update documentatie bijdragers

Dus begin de beschrijving niet met een tweede werkwoord. Het type is er al een, en het onderwerp leidt tot het stapelen van twee zinnen, wat een fix: prefix met zich meebrengt. Laat het werkwoord weg en behoud wat er op werd gewerkt:

# Slecht
💄 verbeter schalen van de juweel op zijn kaart
🐛 fix stop de footer van inpakken

# Goed
💄 verbeter de juweelgrootte op zijn kaart
🐛 fix het inpakken van de footer

Schrijf het in imperatieve wijs en kleine letters:

# Slecht
📝 bijgewerkt documentatie bijdragers

# Slecht
📝 Update documentatie bijdragers

Issue Nummer

Koppel commits aan issues door het issue nummer toe te voegen:

📝 update documentatie bijdragers (#123)

Body

Gebruik het bodygedeelte voor context en motivatie:

📝 update documentatie bijdragers

- Voeg @jerembdn toe als bijdrager
- Voeg @younesbessa toe als bijdrager

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