Zaczynamy

Lubimy mieć czystą historię projektu. Nasza konwencja commitów jest inspirowana Conventional Commits, ale dostosowana z użyciem gitmoji, żeby było to bardziej wizualne i zabawne.

Struktura

Wiadomość commit powinna być zbudowana w następujący sposób i ma być napisana małymi literami:

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

[opcjonalne ciało]

[opcjonalne stopki]

Przykład

📝 update documentation contributors

- Dodaj @jerembdn jako współautora
- Dodaj @younesbessa jako współautora

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

Najczęściej prosta linia wystarczy:

📝 update documentation contributors

Typy

Używamy następujących typów commitów:

Pierwszy commit repozytorium używa initial, a tag wersji używa release:

🎉 initial commit
🔖 release @onruntime/translations v0.3.0

Opis

<type> to czasownik tematu, a opis go uzupełnia. Razem tworzą jedno zdanie:

# Dobrze
📝 update documentation contributors

Więc nie zaczynaj opisu od drugiego czasownika. Typ już jest jednym czasownikiem, a temat kończy się układaniem dwóch zdań, co prowadzi do prefiksu fix:. Porzuć czasownik i zachowaj to, na co miał wpływ:

# Źle
💄 improve scale down the gem on its card
🐛 fix stop the footer from wrapping

# Dobrze
💄 improve the gem size on its card
🐛 fix the footer wrapping

Pisz to w trybie rozkazującym i małymi literami:

# Źle
📝 updated documentation contributors

# Źle
📝 Update documentation contributors

Numer problemu

Linkuj commity do problemów, dodając numer problemu:

📝 update documentation contributors (#123)

Ciało

Użyj ciała w celu kontekstu i motywacji:

📝 update documentation contributors

- Dodaj @jerembdn jako współautora
- Dodaj @younesbessa jako współautora

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