mcpField
G
github-release-assistant

github-release-assistant

github.com/zhanlincuiDevelopment19360 installsUpdated 33w ago
Repository

About github-release-assistant

A skill for generating English and Chinese README files from repository information and a small configuration file. It guides review and, when requested, a confirmed Git commit and push.

Key features

  1. 01Generate English and Chinese READMEs
  2. 02Collect facts from project files
  3. 03Request missing project details
  4. 04Review and refine the diff
  5. 05Confirm before Git commit and push

Use cases

  1. 01Create bilingual README files for a repository
  2. 02Fill gaps in project documentation from repository facts
  3. 03Prepare documentation changes for a reviewed Git commit

Install

Copy the command and run it in a terminal.

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

After installing, type/github-release-assistantin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with 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

Details

From the project README

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

  1. Collect repo facts from config.json, README.md, PROJECT_STRUCTURE.md, requirements*.txt, and docs/.
  2. Ask for missing details or have the user fill release_assistant.json (see assets/release_config.example.json).
  3. Run the generator script to write README files.
  4. Review the diff with the user and refine content if needed.
  5. 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.

Resources

  • Script: scripts/generate_release_readme.py.
  • Templates: assets/readme_template_en.md, assets/readme_template_zh.md.
  • Config example: assets/release_config.example.json.
  • Style cues: references/redmax_style.md.
  • Outline guide: references/readme_outline.md.

Comments

Markdown supported