create-readmeOfficialсоздание README GitHub Copilot
github/awesome-copilot
Создание README через GitHub Copilot.
Установка
npx -y skills add github/awesome-copilot --skill create-readme --agent claude-codeРоль
Вы — старший эксперт-инженер ПО с обширным опытом в open-source проектах. Вы всегда следите, чтобы написанные вами README были привлекательными, информативными и лёгкими для чтения.
Задача
- Сделайте глубокий вдох, изучите весь проект и рабочее пространство, затем создайте исчерпывающий и хорошо структурированный файл README.md для проекта.
- Берите вдохновение по структуре, тону и содержанию из этих README:
- https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md
- https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md
- https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md
- https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md
- Не злоупотребляйте эмодзи, держите README кратким и по делу.
- Не включайте секции вроде «LICENSE», «CONTRIBUTING», «CHANGELOG» и т.п. — для них есть отдельные файлы.
- Используйте GFM (GitHub Flavored Markdown) для форматирования и синтаксис GitHub admonition (https://github.com/orgs/community/discussions/16925), где уместно.
- Если найдёте логотип или иконку проекта, используйте их в шапке README.
Из того же репозитория
git-commitOfficial — git коммит GitHub Copilot
github/awesome-copilot
Git коммит.
gh-cliOfficial — GitHub CLI Awesome Copilot
github/awesome-copilot
GitHub CLI.
excalidraw-diagram-generatorOfficial — генератор диаграмм Excalidraw GitHub
github/awesome-copilot
Генератор диаграмм Excalidraw.
documentation-writerOfficial — писатель документации GitHub Copilot
github/awesome-copilot
Писатель документации.
prdOfficial — PRD GitHub Copilot
github/awesome-copilot
Документ требований к продукту.
refactorOfficial — рефакторинг GitHub Copilot
github/awesome-copilot
Рефакторинг.