Agent skill · writing content · aiskillstore
github-release-assistant
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.
Why this skill is useful
Adds a script for generating bilingual README files and a structured workflow for GitHub releases that the AI wouldn't reliably generate on its own.
What it needs
Requires python3 installed locally. About 1k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
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, PROJECTSTRUCTURE.md, requirements.txt, and docs/. 2. Ask for missing details or have the user fill releaseassistant.json (see assets/releaseconfig.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 releaseassistant.json in the repo root (optional but recommended). Run: python3 /Users/cuizhanlin/.codex/skills/github-release-assistant/scripts/generatereleasereadme.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/generatereleasereadme.py. Templates: assets/readmetemplateen.md, assets/readmetemplatezh.md. Config example: assets/releaseconfig.example.json. Style cues: references/redmaxstyle.md. Outline guide: references/readmeoutline.md.
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/github-release-assistant