Przejdź do treści

Conventional Commits

Conventional Commits1 to konwencja nazewnictwa wiadomości commitów, która wprowadza porządek, czytelność i automatyzację do historii projektu. W tym artykule pokażę Ci, jak działa, dlaczego warto ją wdrożyć i jak zacząć.

📌 Format:

<typ>[!][(zakres)]: krótki opis

Example

Przykłady:

  • feat: dodano możliwość logowania
  • fix(auth): poprawiono błąd walidacji tokenu
  • refactor!: przebudowa systemu autoryzacji
  • chore(ci): aktualizacja pipeline’a

🔧 Najczęstsze typy:

  • feat – nowa funkcja
  • fix – poprawka błędu
  • docs – zmiana w dokumentacji
  • style – formatowanie, brak zmian w logice
  • refactor – zmiany w strukturze kodu
  • test – testy
  • chore – zadania techniczne

🚀 Korzyści:

  • ✅ Czytelna historia zmian
  • ✅ Automatyczne wersjonowanie (semantic-release)
  • ✅ Generowanie changelogów
  • ✅ Lepsza współpraca zespołowa
  • ✅ Łatwiejsze code review

🛠️ Narzędzia:

  • commitlint – sprawdza poprawność commitów
  • commitizen – kreator commitów
  • semantic-release – automatyczny release na podstawie commitów
  • husky – hooki Gita

✅ Pro tip:

Dodaj ! po typie commit’a jeśli commit wprowadza breaking change:

Example

git commit -m 'refactor!: zmieniono sposób uwierzytelniania'

  1. https://www.conventionalcommits.org/en/v1.0.0/ ↩