Рефакторит Python-скрипты в проекты для начинающих, добавляя обучающие комментарии и создавая подробное руководство в README.md.
- Звёзды на GitHub
- 41 038
- Файлы
- 1
- Последний коммит
- 11 нояб. 2026 г.
- Лицензия
- MIT
- Разрешённые инструменты
- —
Что делает навык comment-code-generate-a-tutorial?
comment-code-generate-a-tutorial — это Agent Skill. Рефакторит Python-скрипты в проекты для начинающих, добавляя обучающие комментарии и создавая подробное руководство в README.md.
Сводка сгенерирована из SKILL.md навыка.
О skill comment-code-generate-a-tutorial
Основная функция этого инструмента — превращение сырых Python-скриптов в образовательные ресурсы для начинающих разработчиков. Он берет существующий скрипт и применяет рекомендации PEP 8, чтобы код соответствовал стандартным лучшим практикам Python. Переименовывая неясные переменные и функции, этот SKILL создает более чистую версию исходной логики, которую студентам будет проще изучать.
Агенту следует загрузить этот SKILL, когда пользователю нужно превратить одиночный файл в полноценный пакет проекта. Процесс включает добавление обучающих комментариев, которые объясняют логику работы, а не просто синтаксис. В завершение этот SKILL генерирует файл README.md, содержащий обзор проекта, инструкции по настройке, разбор принципов работы кода и фрагменты с примерами использования. Это превращает простой скрипт в структурированный учебный модуль.
Что агент может делать с ним
- 1Преобразование скриптов в образовательные проектыПревратите одиночный Python-скрипт в аккуратный проект для начинающих с обучающими комментариями и руководством.
- 2Создание подробной документации проектаГенерируйте файл README.md, который включает инструкции по настройке, разбор логики и примеры использования.
Написано на основе skill SKILL.md. Каждый сценарий использования проверен по цитате из него.
Как установить навык comment-code-generate-a-tutorial
Каждая команда копирует папку навыка в каталог навыков клиента. Перезапустите клиент или начните новую сессию, чтобы загрузить его.Установка навыка comment-code-generate-a-tutorial в Claude Code
~/.claude/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.claude/skills/comment-code-generate-a-tutorialУстановка навыка comment-code-generate-a-tutorial в Claude Code (project)
.claude/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial .claude/skills/comment-code-generate-a-tutorialУстановка навыка comment-code-generate-a-tutorial в Codex
~/.agents/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.agents/skills/comment-code-generate-a-tutorialУстановка навыка comment-code-generate-a-tutorial в Gemini CLI
~/.gemini/skills/comment-code-generate-a-tutorial/SKILL.md
$ npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.gemini/skills/comment-code-generate-a-tutorialУстановка навыка comment-code-generate-a-tutorial в Claude.ai
npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial comment-code-generate-a-tutorial && zip -r comment-code-generate-a-tutorial.zip comment-code-generate-a-tutorial # claude.ai → Customize → Skills → + → Create skill → Upload a skill → comment-code-generate-a-tutorial.zip
Автоматические проверки
Запущено 14 нояб. 2026 г.Полный отчёт →Прошёл наши автоматические проверки. Это не аудит безопасности: прочитайте скрипты, прежде чем агент их запустит. Как работают проверки
- Связанный и доступный исходный репозиторийgithub/awesome-copilot/skills/comment-code-generate-a-tutorial is public and reachablegithub.com/github/awesome-copilot/tree/HEAD/skills/comment-c ↗Пройдено
- Open source лицензия (OSI)MITspdx.org/licenses/MIT.html ↗Пройдено
- Коммит или релиз за последний годLast commit 2026-11-11github.com/github/awesome-copilot/commits ↗Пройдено
- В скриптах нет загрузки с запуском и кражи учётных данныхNo scripts in the skill folderПройдено
- В SKILL.md нет скрытых инструкцийNo override phrases, safeguard switches, credential requests or hidden charactersgithub.com/github/awesome-copilot/blob/HEAD/skills/comment-c ↗Пройдено
- Заранее разрешённые инструменты ограниченыNo pre-approved tools; the agent asks before using onegithub.com/github/awesome-copilot/blob/HEAD/skills/comment-c ↗Пройдено
SKILL.md
Открыть на GitHubTransform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.
-
Refactor the code
- Apply standard Python best practices
- Ensure code follows the PEP 8 style guide
- Rename unclear variables and functions if needed for clarity
-
Add comments throughout the code
- Use a beginner-friendly, instructional tone
- Explain what each part of the code is doing and why it's important
- Focus on the logic and reasoning, not just syntax
- Avoid redundant or superficial comments
-
Generate a tutorial as a
README.mdfile
Include the following sections:- Project Overview: What the script does and why it's useful
- Setup Instructions: Prerequisites, dependencies, and how to run the script
- How It Works: A breakdown of the code logic based on the comments
- Example Usage: A code snippet showing how to use it
- Sample Output: (Optional) Include if the script returns visible results
- Use clear, readable Markdown formatting
Файлы в этом навыке
1Вопросы о навыке comment-code-generate-a-tutorial
Как установить навык comment-code-generate-a-tutorial в Claude Code?
Выполните npx degit github/awesome-copilot/skills/comment-code-generate-a-tutorial ~/.claude/skills/comment-code-generate-a-tutorial. Claude Code загружает навыки из ~/.claude/skills (все проекты) или .claude/skills (один проект) и использует навык, когда его описание соответствует задаче.
Какие клиенты могут использовать навык comment-code-generate-a-tutorial?
Любой клиент, который читает формат Agent Skills: Claude Code, Codex, Gemini CLI и claude.ai (загрузить как ZIP). Скрипты в навыке выполняются только там, где клиент разрешает выполнение кода.
Каким стандартам кодирования следует этот SKILL?
Этот SKILL гарантирует, что рефакторинг кода соответствует руководству по стилю PEP 8 и применяет общепринятые лучшие практики Python.
Какие разделы включены в созданное руководство?
Сгенерированный README.md включает обзор проекта, инструкции по настройке, разбор логики, примеры использования и необязательный пример вывода.