github-release-assistant について
github-release-assistantは、リポジトリ内の資料と設定ファイルから英語・中国語のREADMEを生成するスキルです。変更内容の確認を支援し、明示的な承認後にコミットとプッシュを案内します。
主な機能
- 01リポジトリのファイルから情報を収集
- 02英語・中国語のREADMEを生成
- 03設定可能なREADMEテンプレートを使用
- 04生成差分の確認と修正
- 05承認後のコミットとプッシュを案内
活用シーン
- 01プロジェクト公開用の二言語README作成
- 02コミット前のドキュメント変更確認
- 03明示的な承認後のREADME更新公開
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/github-release-assistantを入力して読み込まれたか確認します。
詳細
GitHub リリースアシスタント
概要
リポジトリの情報と小さな設定ファイルを使い、簡潔な「Redmax スタイル」のレイアウトに沿って、洗練された英語と中国語の README ファイルを生成します。README.md と README.zh.md を作成し、必要に応じて git のクリーンなコミットとプッシュを案内します。
ワークフロー
config.json、README.md、PROJECT_STRUCTURE.md、requirements*.txt、docs/からリポジトリの情報を収集します。- 不足している情報を確認するか、ユーザーに
release_assistant.jsonへの記入を依頼します（assets/release_config.example.jsonを参照）。 - 生成スクリプトを実行して、README ファイルを作成します。
- ユーザーと差分を確認し、必要に応じて内容を調整します。
- 依頼された場合は、明示的な確認を得てから変更をステージング、コミット、プッシュします。
クイックスタート
- リポジトリのルートに
release_assistant.jsonを作成または編集します（任意ですが、推奨です）。 - 次を実行します：
python3 /Users/cuizhanlin/.codex/skills/github-release-assistant/scripts/generate_release_readme.py --project-root <repo> --language both --overwrite README.mdとREADME.zh.mdを確認します。
Git ワークフロー（コミット＋プッシュ）
git statusとgit diffを実行して変更を表示します。git add、git commit、git pushの前に確認を求めます。- 簡潔なコミットメッセージ（例：
docs: add bilingual README）を提案し、承認を待ちます。
リソース
- スクリプト：
scripts/generate_release_readme.py。 - テンプレート：
assets/readme_template_en.md、assets/readme_template_zh.md。 - 設定例：
assets/release_config.example.json。 - スタイルの手がかり：
references/redmax_style.md。 - アウトラインガイド：
references/readme_outline.md。
コメント
Markdown 対応