mcpField
G
github-release-assistant

github-release-assistant

github.com/zhanlincui开发19360 次安装33 周前更新
代码仓库

关于 github-release-assistant

一项根据仓库信息和配置文件生成中英文 README 的 Skill。它支持审阅和修改内容，并可在获得明确确认后指导 Git 提交与推送。

主要功能

  1. 01生成中英文 README
  2. 02从项目文件收集信息
  3. 03询问缺失的项目详情
  4. 04审阅并完善差异
  5. 05提交和推送前征求确认

适用场景

  1. 01为仓库创建双语 README
  2. 02根据仓库事实补充项目文档
  3. 03审阅文档变更后准备 Git 提交

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/zhanlincui/agent-skills-hunter --skill github-release-assistant

安装后在 Claude Code 中输入/github-release-assistant确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

assets/
readme_template_en.md
readme_template_zh.md
release_config.example.json
references/
readme_outline.md
redmax_style.md
scripts/
generate_release_readme.py

详细介绍

GitHub 发布助手

概述

根据仓库信息和一个小型配置文件，按照简洁的“Redmax 风格”布局，生成精炼的中英文 README 文件。生成 README.md 和 README.zh.md，之后还可指导用户完成规范的 Git 提交和推送。

工作流

  1. 从 config.json、README.md、PROJECT_STRUCTURE.md、requirements*.txt 和 docs/ 收集仓库信息。
  2. 询问缺失的信息，或让用户填写 release_assistant.json（参见 assets/release_config.example.json）。
  3. 运行生成脚本以编写 README 文件。
  4. 与用户一起检查差异，并根据需要完善内容。
  5. 如有需要，在明确确认后暂存、提交并推送更改。

快速开始

  • 在仓库根目录中创建或编辑 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