readme-updater
Automatycznie aktualizuj README gdy zmienia się kod projektu
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill, który pilnuje, aby dokumentacja README zawsze była zsynchronizowana ze stanem projektu. Monitoruje zmiany w strukturze kodu, nowe funkcjonalności, zależności i instrukcje konfiguracji, a następnie sugeruje konkretne aktualizacje do dokumentacji. Działa automatycznie po dodaniu nowych featur, modyfikacji plików konfiguracyjnych czy zmianach w zależnościach projektu. Oszczędza czas na ręcznym aktualizowaniu dokumentacji i zmniejsza ryzyko, że README będzie nieaktualny.
Jak używać
Zainstaluj skill readme-updater w swoim środowisku Claude/Copilot, wskazując repozytorium projektu. Skill będzie monitorować zmiany w kodzie automatycznie.
Dokonaj zmian w projekcie, takich jak dodanie nowych funkcjonalności, zmiana struktury katalogów, dodanie lub usunięcie zależności, lub modyfikacja instrukcji konfiguracji. Skill automatycznie wykryje te zmiany.
Skill przeanalizuje zmienione pliki (package.json, pliki konfiguracyjne, nowe komponenty) i zasugeruje konkretne aktualizacje do README. Na przykład, jeśli dodasz nową bibliotekę, skill zaproponuje dodanie jej do sekcji Installation.
Przejrzyj sugerowane zmiany w dokumentacji. Skill wskaże dokładnie, które sekcje README wymagają aktualizacji: Installation, Features, Usage, Configuration lub Development Setup.
Zatwierdź proponowane zmiany lub dostosuj je do swoich potrzeb. Skill może automatycznie zaktualizować README lub przygotować pull request z sugerowanymi zmianami.
Powtarzaj ten proces przy każdej znaczącej zmianie w projekcie, aby dokumentacja zawsze odzwierciedlała aktualny stan kodu.