Agent Skills › ZhanlinCui/Agent-Skills-Hunter › github-release-assistant

github-release-assistant

GitHub

根据仓库元数据和用户输入，生成中英双语的 GitHub Release 文档（README.md 和 README.zh.md），并指导 git add、commit 及 push 操作。

docs/github-release-assistant/SKILL.md ZhanlinCui/Agent-Skills-Hunter

Trigger Scenarios

编写或润色 README 文件创建双语文档准备 GitHub Release 提及 release assistant 或 README 生成

Install

npx skills add ZhanlinCui/Agent-Skills-Hunter --skill github-release-assistant -g -y

More Options

Non-standard path

npx skills add https://github.com/ZhanlinCui/Agent-Skills-Hunter/tree/main/docs/github-release-assistant -g -y

Use without installing

npx skills use ZhanlinCui/Agent-Skills-Hunter@github-release-assistant

指定 Agent (Claude Code)

npx skills add ZhanlinCui/Agent-Skills-Hunter --skill github-release-assistant -a claude-code -g -y

安装 repo 全部 skill

npx skills add ZhanlinCui/Agent-Skills-Hunter --all -g -y

预览 repo 内 skill

npx skills add ZhanlinCui/Agent-Skills-Hunter --list

SKILL.md

Frontmatter

{
    "name": "github-release-assistant",
    "description": "Generate bilingual GitHub release documentation (README.md + README.zh.md) from repo metadata and user input, and guide release prep with git add\/commit\/push. Use when the user asks to write or polish README files, create bilingual docs, prepare a GitHub release, or mentions release assistant\/README generation."
}

GitHub Release Assistant

Overview

Generate polished README files in English and Chinese using repo facts plus a small config file, following a concise “Redmax-style” layout. Produce README.md + README.zh.md, then optionally guide a clean git commit and push.

Workflow

Collect repo facts from config.json, README.md, PROJECT_STRUCTURE.md, requirements*.txt, and docs/.
Ask for missing details or have the user fill release_assistant.json (see assets/release_config.example.json).
Run the generator script to write README files.
Review the diff with the user and refine content if needed.
If requested, stage/commit/push changes with explicit confirmation.

Quick Start

Create or edit release_assistant.json in the repo root (optional but recommended).
Run: python3 /Users/cuizhanlin/.codex/skills/github-release-assistant/scripts/generate_release_readme.py --project-root <repo> --language both --overwrite
Verify README.md and README.zh.md.

Git Workflow (Commit + Push)

Run git status and git diff to show changes.
Ask for confirmation before git add, git commit, and git push.
Propose a concise commit message (e.g., docs: add bilingual README), and wait for approval.