documentation
Feature documentation and release notes patterns. Use when documenting changes, writing PR descriptions, or preparing releases.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Feature documentation and release notes patterns. Use when documenting changes, writing PR descriptions, or preparing releases.
How to use
Zainstaluj skill documentation z repozytorium Comet ML — dodaj go do swojego agenta lub narzędzia dokumentacyjnego zgodnie z instrukcją integracji MCP.
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).
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.
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ą).
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.
Sprawdź plik release-drafter.yml i dokumentację routing rules, aby upewnić się, że struktura changelog'a jest spójna z konfiguracją nawigacji projektu.