Toolverse
Wszystkie skille

conventional-commit

autor: carbon-design-system

Automatyzuj formatowanie commitów Git zgodnie ze standardem Conventional Commits

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
DevOps
Wyświetlenia
21

O skillu

Skill do generowania i walidacji wiadomości commitów Git. Narzędzie wymusza standard Conventional Commits z obsługą typów zmian (feat, fix, chore, docs, style, refactor, perf, test) i reguł lintingu specyficznych dla projektu. Zapewnia spójność wiadomości commitów w zespole poprzez automatyczne formatowanie nagłówka, opcjonalną sekcję body oraz footer z odwołaniami do zadań. Maksymalna długość nagłówka to 100 znaków, bez kropki na końcu opisu.

Jak używać

  1. Przeanalizuj zmienione pliki w gicie. Skill automatycznie przegląda staged changes za pomocą git diff --cached lub analizuje dostarczoną zawartość zmian.
  2. Określ typ zmiany spośród dostępnych opcji: feat dla nowych funkcji, fix dla poprawek błędów, chore dla zmian w narzędziach i konfiguracji, docs dla zmian w dokumentacji, style dla formatowania, refactor dla refaktoryzacji kodu, perf dla poprawy wydajności, test dla testów.
  3. Sformatuj nagłówek wiadomości commitów w formacie: typ[opcjonalny-zakres]: opis. Pamiętaj, że nagłówek nie może przekroczyć 100 znaków, opis musi być w trybie rozkazującym (np. "zmień" zamiast "zmienił"), zaczynać się małą literą i nie kończyć się kropką.
  4. Dodaj opcjonalnie sekcję body, jeśli zmiana jest złożona. Zawijaj linie na 72 znakach, aby zachować czytelność.
  5. Uzupełnij opcjonalnie footer wiadomości, aby wskazać breaking changes lub odwołać się do zadań (np. Resolves #123).
  6. Skill waliduje wiadomość commitów zgodnie z konfiguracją @commitlint/config-conventional i wymusza maksymalną długość nagłówka 100 znaków oraz brak znaku interpunkcyjnego na końcu opisu.

Podobne skille