Скиллы/Разработка/comment-code-generate-a-tutorial

comment-code-generate-a-tutorial

Превращение Python-скрипта в учебный проект

github/awesome-copilotОт разработчика платформы

39 901звёзд 5 096форковУ всего репозитория

Что получите

Переработанный Python-код с учебными комментариями и руководство в README.md; пример вывода добавляется при необходимости.

Что передать

Python-скрипт, который нужно объяснить начинающим.

Автопроверка файлов16.09.2026

Проверен состав файлов. Запуск не тестировался. Что проверено

Оценки пользователей

Загрузка оценок…

Ваш опыт

Обсудить →

Как использовать

Помогает разработчикам подготовить Python-скрипт для начинающих. Делает код понятнее, добавляет объясняющие комментарии и сопровождает проект учебным руководством.

Приведите код к стилю PEP 8 и уточните непонятные названия.
Добавьте комментарии, объясняющие логику и причины решений без очевидных повторов.
Подготовьте описание проекта, установку, запуск, разбор работы и пример использования.

Пример запроса после установки

Преврати этот Python-скрипт обработки CSV в учебный проект для новичков: улучши читаемость, объясни логику комментариями и подготовь README.md с запуском.

Пример составлен по инструкции автора; результат запуска не проверялся.

Основание: инструкция закреплённой версии

Для установки

Node.js, npm и Git для команды выше. Подключения и инструменты для работы скилла настраиваются отдельно.

Совместимые агенты

Claude Code Codex Cursor OpenCode

Совместимость указана для инструкций. Запуск в каждом приложении не тестировался; для веб-чата способ подключения может отличаться.

Файлы скилла

GitHub

SKILL.md2 КБ

Читать инструкцию SKILL.md

Исходный текст закреплённой версии.

---
name: comment-code-generate-a-tutorial
description: 'Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.'
---

Transform this Python script into a polished, beginner-friendly project by refactoring the code, adding clear instructional comments, and generating a complete markdown tutorial.

1. **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

1. **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

1. **Generate a tutorial as a `README.md` file**  
   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

Проверка и особенности

Автоматическая проверка источника и файлов

Автоматически сверены публичный репозиторий, лицензия, YAML-заголовок SKILL.md, состав папки и Git-хеш каждого файла. Исполняемые файлы и срабатывания статических правил исключены из этой партии. Ручной аудит всех инструкций и проверка работы не проводились; эта проверка не гарантирует безопасность. Команда закреплена на проверенном коммите.

Интерес к репозиторию оцениваем по звёздам и форкам GitHub. Это показатели всего репозитория, а не числа установок отдельного скилла.

Проверка состава: 16.09.2026
Проверенная версия: 9ce814859eaa
Файлы с кодом: Не указаны в данных проверки
Изменения на GitHub: Нужна повторная проверкаПоследняя проверка: 11.10.2026

Как мы проверяем скиллы

Репозиторий и лицензия

github/awesome-copilot

39 901 звёзд5 096 форков

Это показатели всего репозитория, а не установки скилла. Снимок требует обновления.

Другие скиллы из этого репозитория

Последняя активность GitHub: 09.10.2026
Лицензия: MIT
Добавлен в каталог: 16.09.2026

Полный текст лицензии

MIT License

Copyright GitHub, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Ещё в этой категории

Все в категории

Обсуждение

Правила

Пользовались этим скиллом? Делитесь опытом без регистрации. Все комментарии проверяет модератор.

Мои комментарии