Toolverse
Wszystkie skille

updating-changelog

autor: AztecProtocol

Automatyczne aktualizacje dokumentacji zmian dla deweloperów i operatorów węzłów

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
Backend
Wyświetlenia
3

O skillu

Umożliwia szybkie przygotowanie dokumentacji zmian przez analizę różnic między gałęziami. Narzędzie kategoryzuje zmiany łamiące API, nowe funkcje, deprecacje i modyfikacje konfiguracji, a następnie generuje wpisy w formacie zgodnym z konwencjami projektu. Idealne do przygotowania PR-ów, aktualizacji notatek migracyjnych i dokumentowania zmian dla deweloperów kontraktów Aztec oraz operatorów węzłów.

Jak używać

  1. Zainstaluj umiejętność w swoim środowisku Claude, wskazując repozytorium AztecProtocol.
  2. Przeczytaj plik .release-please-manifest.json, aby ustalić numer wersji (np. 4.0.0 → edytujesz v4.md).
  3. Uruchom git diff next...HEAD --stat dla przeglądu zmian, a następnie git diff next...HEAD dla szczegółów.
  4. Skategoryzuj zmiany na: zmiany łamiące API, nowe funkcje, deprecacje oraz zmiany konfiguracji (flagi CLI, zmienne środowiskowe).
  5. Wygeneruj szkic wpisów dokumentacji, dopasowując format do istniejących wpisów w plikach docelowych (migration_notes.md dla deweloperów lub changelog/v{major}.md dla operatorów).
  6. Prześlij szkic do zatwierdzenia przed edycją plików, a następnie dodaj zatwierdzone wpisy do odpowiednich sekcji dokumentacji.

Podobne skille