github-release-assistant

GitHub リリースアシスタント

概要

リポジトリの情報と小さな設定ファイルを使い、簡潔な「Redmax スタイル」のレイアウトに沿って、洗練された英語と中国語の README ファイルを生成します。README.md と README.zh.md を作成し、必要に応じて git のクリーンなコミットとプッシュを案内します。

ワークフロー

1. config.json、README.md、PROJECT_STRUCTURE.md、requirements*.txt、docs/ からリポジトリの情報を収集します。
2. 不足している情報を確認するか、ユーザーに release_assistant.json への記入を依頼します（assets/release_config.example.json を参照）。
3. 生成スクリプトを実行して、README ファイルを作成します。
4. ユーザーと差分を確認し、必要に応じて内容を調整します。
5. 依頼された場合は、明示的な確認を得てから変更をステージング、コミット、プッシュします。

クイックスタート

• リポジトリのルートに 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。