documentation

Skill dokumentacyjny, który dostarcza gotowe wzory dla opisów pull requestów, wpisów changelog'a i dokumentacji funkcji. Używaj go, gdy musisz udokumentować zmiany w kodzie, przygotować notkę wydania lub opisać nową funkcjonalność. Zawiera szablony dla podsumowania zmian, planu testów, powiązanych issue'ów, a także strukturę dla nowych funkcji, ulepszeń, poprawek błędów i zmian łamiących. Skill wskazuje także, do których plików w projekcie wpisywać zmiany — czy do głównego CHANGELOG.md, czy do dokumentacji produktu.

1. Zainstaluj skill documentation z repozytorium Comet ML — dodaj go do swojego agenta lub narzędzia dokumentacyjnego zgodnie z instrukcją integracji MCP.

2. Gdy tworzysz pull request, użyj szablonu PR Description: zacznij od sekcji Summary (co robi PR), dodaj Test Plan (jak zweryfikować działanie) i Related Issues (które issue'y rozwiązuje).

3. Dla wpisów changelog'a wybierz odpowiedni format: dodaj numer wersji i datę, a następnie kategoryzuj zmiany na New Features, Improvements, Bug Fixes i Breaking Changes — każdy wpis powinien zawierać krótki opis i numer issue'a.

4. Przy dokumentowaniu nowej funkcji pokryj trzy obszary: User Impact (co zyskuje użytkownik, jak dostęp do funkcji), Technical Changes (zmiany w API, SDK, bazie danych, konfiguracji) i Breaking Changes (jeśli dotyczą).

5. Upewnij się, że wpis trafia do właściwego pliku — używaj głównego CHANGELOG.md tylko dla zmian łamiących i krytycznych w self-hosted deployment, a ogólne notkę wydania wpisuj do pliku .mdx w folderze dokumentacji produktu.

6. Sprawdź plik release-drafter.yml i dokumentację routing rules, aby upewnić się, że struktura changelog'a jest spójna z konfiguracją nawigacji projektu.