readme-updater
Keep README files current with project changes. Use when project structure changes, features added, or setup instructions modified. Suggests README updates based on code changes. Triggers on significant project changes, new features, dependency changes.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Keep README files current with project changes. Use when project structure changes, features added, or setup instructions modified. Suggests README updates based on code changes. Triggers on significant project changes, new features, dependency changes.
How to use
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.