zhanlincui-github-release-assistant – 生成双语 GitHub Release README Skill 技能

# 生成双语 GitHub Release README - 技能简介 zhanlincui-github-relea

生成双语 GitHub Release README - 技能简介

zhanlincui-github-release-assistant 是一项针对 Coding Agent 的发布辅助技能,专门解决「每次发版都要花时间整理 README 与 Release Notes」的痛点。它引导 Claude、Codex、Claude Code 根据仓库元数据自动生成中英双语 README,并通过受控的 Git 工作流完成 diff、commit、push 操作。

核心能力

  • 从仓库元数据与可选的 release_assistant.json 生成 README.md 与 README.zh.md。
  • 读取常见项目文件:README.md、config.json、PROJECT_STRUCTURE.md、文档与依赖文件。
  • 自动构建覆盖概览、目录、能力、组件、快速开始、配置、许可与致谢的中英双语文档。
  • 在 License 与 Python 版本数据可用时,自动补充 Shields.io 与 Python 版本徽章。
  • 通过脚本参数支持「仅英文」「仅中文」「双语」三种输出模式。
  • 引导 git status、diff、commit 与 push 全流程,且每一步都需要用户确认。

安装配置

  • 通过 Skillstore CLI 一键安装:npx skillstore add zhanlincui/github-release-assistant。
  • 安装后,Claude Code / Codex / Claude 在发布相关任务时会自动加载该技能。
  • 本技能需要本地仓库环境与 Git 权限(commit/push 需用户逐次授权)。

使用步骤

  1. 启动 Agent 后,明确需求:「为当前仓库生成中英双语的发布 README」。
  2. 提供 release_assistant.json(如已有)或让 Agent 读取仓库现有元数据。
  3. Agent 先生成 README.md 与 README.zh.md 草稿,并标注缺失信息。
  4. 审阅两版 README,确认覆盖概览、快速开始、能力、配置、许可等关键章节。
  5. 在 Agent 引导下完成 git status、diff、commit 与 push 操作(每步都需要用户授权)。

适用场景

  • 发版前生成双语 README:英文与中文并行,提升国际用户与中文社区覆盖率。
  • 刷新发版前的文档:补充概览、快速开始、能力、许可等关键模块。
  • 规范化双语项目文档:通过统一模板保持多仓库文档风格一致。
  • 在 GitHub Release 页面同步展示中英双语说明。
  • 维护开源项目的国际化文档基础。

适用人群

  • 开源项目维护者与文档负责人。
  • 需要做国际化的国内技术团队。
  • Coding Agent 高频用户。
  • 重视发版流程标准化与文档一致性的项目团队。

工作原理

该技能把 Release README 生成拆解为「读取仓库元数据 → 模板化渲染 → diff 校对 → 受控 Git 操作」四个阶段。它从 README.md、config.json、PROJECT_STRUCTURE.md 等常见项目文件中提取事实,按统一的双语模板渲染,再生成对应的 Markdown 文档;最后在用户逐次授权下走 git diff、commit、push 流程,避免误操作。安装时通过 npx skillstore add 完成,无需手动配置路径。

官方链接

https://skillstore.io/skills/zhanlincui-github-release-assistant

团队信息

由 AI 猎手自动发现

评论与建议

0 条评论