Rozpoczęcie pracy

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

Struktura

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

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

[opcjonalne body]

[opcjonalne footer(y)]

Przykład

📝 zaktualizuj współautorów dokumentacji

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

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

Najczęściej wystarczy prosty jednolinijkowiec:

📝 zaktualizuj współautorów dokumentacji

Typy

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

Opis

Pisanie opisów w trybie rozkazującym i małymi literami:

# Dobrze
📝 zaktualizuj współautorów dokumentacji

# Źle
📝 zaktualizowane współautorzy dokumentacji

# Źle
📝 Zaktualizuj współautorów dokumentacji

Numer Zgłoszenia

Połącz commit z zgłoszeniem, dodając numer zgłoszenia:

📝 zaktualizuj współautorów dokumentacji (#123)

Body

Użyj body dla kontekstu i motywacji:

📝 zaktualizuj współautorów dokumentacji

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

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