agentsclimarketplace
Sign in

Github release assistant

Skill bg-szy/TOP-SKILLS/skills/marketplace/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.From its SKILL.md

Install
npx -y skills add bg-szy/TOP-SKILLS --skill github-release-assistant

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

2 things to look at

  • no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
  • 5 stars5 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

1.9 KB, 366 tokens by cl100k_base, as published. Nobody here has run it

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.

What ships with it: 1 file

33.1 KB alongside SKILL.md

Keep looking

Skills are one crate of 325,949. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.