C
conventional-commit
Automatyzuj formatowanie commitów Git zgodnie ze standardem Conventional Commits
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
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ć
- Przeanalizuj zmienione pliki w gicie. Skill automatycznie przegląda staged changes za pomocą
git diff --cachedlub analizuje dostarczoną zawartość zmian. - Określ typ zmiany spośród dostępnych opcji:
featdla nowych funkcji,fixdla poprawek błędów,choredla zmian w narzędziach i konfiguracji,docsdla zmian w dokumentacji,styledla formatowania,refactordla refaktoryzacji kodu,perfdla poprawy wydajności,testdla testów. - 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ą. - Dodaj opcjonalnie sekcję body, jeśli zmiana jest złożona. Zawijaj linie na 72 znakach, aby zachować czytelność.
- Uzupełnij opcjonalnie footer wiadomości, aby wskazać breaking changes lub odwołać się do zadań (np.
Resolves #123). - Skill waliduje wiadomość commitów zgodnie z konfiguracją
@commitlint/config-conventionali wymusza maksymalną długość nagłówka 100 znaków oraz brak znaku interpunkcyjnego na końcu opisu.