关于 github-release-assistant
github-release-assistant 是一项根据仓库资料和配置文件生成中英文 README 的技能。它还可协助检查差异，并在获得明确确认后指导提交和推送。
主要功能
- 01从仓库文件收集项目资料
- 02生成中英文 README
- 03使用可配置的 README 模板
- 04检查并完善生成的差异
- 05指导经确认的提交与推送
适用场景
- 01为项目发布准备双语 README
- 02提交前检查文档变更
- 03明确获准后发布 README 更新
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/github-release-assistant确认已加载。
详细介绍
GitHub 发布助手
概述
根据仓库信息和一个小型配置文件，按照简洁的“Redmax 风格”布局，生成精炼的中英文 README 文件。生成 README.md 和 README.zh.md，之后还可指导用户完成规范的 Git 提交和推送。
工作流
- 从
config.json、README.md、PROJECT_STRUCTURE.md、requirements*.txt和docs/收集仓库信息。 - 询问缺失的信息，或让用户填写
release_assistant.json（参见assets/release_config.example.json）。 - 运行生成脚本以编写 README 文件。
- 与用户一起检查差异，并根据需要完善内容。
- 如有需要，在明确确认后暂存、提交并推送更改。
快速开始
- 在仓库根目录中创建或编辑
release_assistant.json（可选，但建议填写）。 - 运行：
python3 /Users/cuizhanlin/.codex/skills/github-release-assistant/scripts/generate_release_readme.py --project-root <repo> --language both --overwrite - 检查
README.md和README.zh.md。
Git 工作流（提交 + 推送）
- 运行
git status和git diff以展示更改。 - 在运行
git add、git commit和git push前征求确认。 - 提议一条简洁的提交信息（例如：
docs: add bilingual README），并等待批准。
资源
- 脚本：
scripts/generate_release_readme.py。 - 模板：
assets/readme_template_en.md、assets/readme_template_zh.md。 - 配置示例：
assets/release_config.example.json。 - 风格参考：
references/redmax_style.md。 - 大纲指南：
references/readme_outline.md。
评论
支持 Markdown