Навыки github-release-assistant

📦

github-release-assistant

Name: github-release-assistant
Author: ZhanlinCui

Безопасно

Генерация двуязычной документации для релизов GitHub

Создание качественной документации для релизов требует времени и согласованности между языками. Этот навык автоматизирует генерацию двуязычных README-файлов на основе существующих метаданных репозитория.

Поддерживает: Claude Codex Code(CC)

🥇 84 Золото

Скачать ZIP навыка

Загрузить в Claude

Перейдите в Settings → Capabilities → Skills → Upload skill

Включите и начните использовать

Протестировать

Использование «github-release-assistant». Репозиторий с config.json, содержащим метаданные проекта, и файлом requirements.txt

Ожидаемый результат:

Создано два файла: README.md (на английском) и README.zh.md (на китайском) с одинаковой структурой, включающей обзор проекта, ключевые возможности, инструкции по быстрому старту и значки лицензии

Использование «github-release-assistant». Запуск генератора с флагами --language both --overwrite для существующей документации

Ожидаемый результат:

Обновленные README-файлы заменяют предыдущие версии, сохраняя историю git через подготовленные изменения, готовые к проверке

Аудит безопасности

Безопасно

v1 • 2/24/2026

Static analysis flagged 53 patterns but all are false positives. The 'weak cryptographic algorithm' warnings match MATLAB function names (BDF1, BDF2, ode45) in documentation, not actual crypto code. 'Ruby backtick execution' is Python code with markdown documentation formatting. Hardcoded URLs are standard badge images from shields.io. Unicode regex detects CJK characters for bilingual support. No malicious intent, no credential handling, no external API calls beyond static badge URLs.

Просканировано файлов

676

Проанализировано строк

находки

Всего аудитов

Проблем безопасности не найдено

Проверено: claude

Оценка качества

Архитектура

100

Сопровождаемость

Контент

Сообщество

100

Безопасность

Соответствие спецификации

Что вы можете построить

Мейнтейнер проекта с открытым исходным кодом

Генерация согласованной двуязычной документации для релизов без необходимости ручного написания версий на обоих языках.

Международный разработчик

Быстрое создание README-файлов на китайском и английском языках для проектов, ориентированных как на внутреннюю, так и на международную аудиторию.

Распространение исследовательского кода

Создание профессиональной документации для академических релизов ПО с четкой структурой разделов и инструкциями по установке.

Попробуйте эти промпты

Базовая генерация README

Сгенерировать двуязычные README-файлы для моего репозитория, используя шаблон по умолчанию.

Пользовательская конфигурация

Создать README.md и README.zh.md, используя настройки из release_assistant.json для имени проекта, функций и шагов быстрого старта.

Выборочный вывод языка

Сгенерировать только китайский README (README.zh.md), используя существующие метаданные проекта, и перезаписать, если файлы существуют.

Полный рабочий процесс релиза

Сгенерировать оба README-файла, показать мне git diff, затем провести меня через коммит и пуш изменений с соответствующим сообщением коммита.

Лучшие практики

Проверяйте сгенерированное содержимое README перед коммитом, чтобы убедиться в точности извлеченных метаданных
Создайте release_assistant.json с пользовательскими деталями проекта для согласованного вывода между релизами
Используйте git diff для предварительного просмотра изменений перед выполнением операций git add и commit

Избегать

Не коммитьте сгенерированные README-файлы без проверки извлеченного содержимого на точность
Избегайте использования флага --overwrite, если вы не намерены полностью заменить существующую документацию
Не выполняйте git push, предварительно не убедившись, что diff показывает только предполагаемые изменения документации

Часто задаваемые вопросы

Какие файлы нужны этому навыку для генерации документации?

Навык читает config.json, README.md, PROJECT_STRUCTURE.md, requirements.txt и LICENSE из вашего репозитория. Как минимум ему нужен каталог репозитория для извлечения имени проекта.

Могу ли я настроить шаблон README?

Да, отредактируйте файлы шаблонов в assets/readme_template_en.md и assets/readme_template_zh.md или предоставьте пользовательские шаблоны через флаг --template-dir.

Создает ли этот навык фактические релизы GitHub?

Нет, он только генерирует файлы документации README. Создание релизов GitHub через API требует дополнительных разрешений и выходит за рамки этого навыка.

Как навык обрабатывает двуязычный контент?

Он обнаруживает китайские/японские/корейские символы с помощью regex и извлекает содержимое из существующей документации или использует предоставленные значения конфигурации для разделов на английском и китайском языках.

Что если мой проект использует другой формат конфигурации?

Создайте файл release_assistant.json в корне вашего репозитория, следуя примеру в assets/release_config.example.json, чтобы предоставить пользовательские метаданные.

Отправляется ли мой код на внешние серверы во время генерации?

Нет, вся обработка происходит локально. Единственные внешние URL - это статические изображения значков от shields.io, встроенные в сгенерированный README markdown.