用途:为 GitHub 项目生成简洁的“Redmax 风格”英文与中文 README(README.md + README.zh.md),并辅助完成发布前的提交与推送。
主要能力:从 config.json、README.md、PROJECT_STRUCTURE.md、requirements*.txt 和 docs/ 收集仓库事实;对缺失信息向用户提问,或让用户填写 release_assistant.json(参考 assets/release_config.example.json);运行生成脚本写出 README 文件;与用户一起审阅 diff 并修改内容;在用户明确确认后执行暂存、提交与推送。
必要用法:在仓库根目录创建或编辑 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。
限制:官方文档未提供支持的平台、收费或价格信息;实际输出效果与执行步骤依赖本地环境与仓库内容,暂未提供更多细节。