M
massgen-release-documenter
Przewodnik do dokumentacji wydań — utrzymuj spójność zmian w projekcie
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do dokumentowania wydań oprogramowania zgodnie z ustaloną procedurą. Przeprowadzi Cię przez całą dokumentację: od aktualizacji CHANGELOG, przez dokumentację Sphinx, aż po README i mapę drogową. Użyj go, gdy przygotowujesz nowe wydanie, dokumentujesz nowe funkcje, poprawki lub studium przypadku. Zawsze zacznij od CHANGELOG, a następnie postępuj w określonej kolejności, aby uniknąć pominięcia ważnych kroków.
Jak używać
- Zainstaluj skill w swoim środowisku MassGen — dodaj go do konfiguracji agenta lub wczytaj z repozytorium.
- Przed każdym wydaniem otwórz plik
docs/dev_notes/release_checklist.md— jest to źródło prawdy dla całego procesu dokumentacji. - Zacznij od aktualizacji CHANGELOG.md: dodaj nowe funkcje w sekcji Added, zmiany w Changed, poprawki w Fixed, zgodnie z konwencją projektu.
- Przejdź do dokumentacji Sphinx w katalogu
docs/source/— dodaj lub zaktualizuj opisy nowych funkcji i zmian. - Jeśli wydanie zawiera znaczące funkcje, napisz studium przypadku w
docs/source/examples/case_studies/. - Zaktualizuj README.md i ROADMAP.md na koniec — nigdy nie zmieniaj ich przed CHANGELOG, aby uniknąć niespójności.