W
write-release-notes
Twórz profesjonalne notatki wydania dla SDK — od struktury po ostateczną redakcję
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill wspomaga pisanie artykułów z notatkami wydania dla publikacji tldraw SDK. Otrzymujesz wytyczne dotyczące struktury, tonu i zawartości dokumentów wydaniowych. Narzędzie pomaga zarówno przy tworzeniu nowej dokumentacji od zera, jak i przy przeglądzie jakości istniejących notatek. Pracuje z plikami w katalogu apps/docs/content/releases/, gdzie gromadzisz zmiany dla nadchodzących wydań i publikujesz wersje finalne.
Jak używać
- Pobierz numer wersji wydania, które chcesz udokumentować, i sprawdź szczegóły na GitHub za pomocą polecenia
gh release view vX.Y.Z, aby uzyskać datę wydania i tagi. 2. Wylistuj wszystkie pull requesty scalane między poprzednią wersją a bieżącą, używającgit log vX.Y-1.0..vX.Y.0 --oneline --mergeslubgh pr listz filtrem na datę scalenia. 3. Dla każdego PR pobierz pełne szczegóły — tytuł, treść, etykiety i autora — zwracając szczególną uwagę na sekcje### Release notesi### API changesw opisie PR oraz oznaczenia kategorii (api, bugfix, improvement). 4. Upewnij się, że każdy PR został scalony do gałęzimain; pomiń PR scalane do gałęzi funkcyjnych, ponieważ nie są jeszcze wydane. 5. Sprawdź, czy istnieją wydania poprawkowe dla tej wersji minor, używającgh release list | grep "vX.Y". 6. Otwórz odpowiedni plik wapps/docs/content/releases/—next.mdxdla zmian w przygotowaniu lubvX.Y.0.mdxdla wydania — i skomponuj notatki wydania, stosując się do wytycznych dotyczących struktury i tonu dostarczonego przez skill.