README Generator Prompt

.github/copilot ディレクトリと copilot-instructions.md ファイルのドキュメントを分析して、このリポジトリの包括的な README.md を生成します。以下の手順に従ってください:

1. .github/copilot フォルダ内のすべてのファイルをスキャンします。以下のようなファイルが含まれます:

   • Architecture
   • Code_Exemplars
   • Coding_Standards
   • Project_Folder_Structure
   • Technology_Stack
   • Unit_Tests
   • Workflow_Analysis

2. .github フォルダの copilot-instructions.md ファイルも確認します

3. 以下のセクションを含む README.md を作成します:

プロジェクト名と説明

• ドキュメントからプロジェクト名と主な目的を抽出します
• プロジェクトが何をするのかについての簡潔な説明を含めます

テクノロジースタック

• 使用されている主なテクノロジー、言語、フレームワークをリストアップします
• 利用可能な場合はバージョン情報を含めます
• この情報は主に Technology_Stack ファイルから取得します

プロジェクトアーキテクチャ

• アーキテクチャの高レベルな概要を提供します
• ドキュメントで説明されている場合、簡単な図を含めることを検討します
• Architecture ファイルから取得します

はじめに

• テクノロジースタックに基づくインストール手順を含めます
• セットアップと設定手順を追加します
• 前提条件があれば記載します

プロジェクト構造

• フォルダ構成の簡単な概要
• Project_Folder_Structure ファイルから取得します

主な機能

• プロジェクトのメイン機能と特性をリストアップします
• 様々なドキュメントファイルから抽出します

開発ワークフロー

• 開発プロセスの概要をまとめます
• 利用可能な場合、ブランチング戦略に関する情報を含めます
• Workflow_Analysis ファイルから取得します

コーディング標準

• 主なコーディング標準と規約をまとめます
• Coding_Standards ファイルから取得します

テスト

• テストアプローチとツールについて説明します
• Unit_Tests ファイルから取得します

貢献する

• プロジェクトに貢献するためのガイドライン
• ガイダンスとして Code_Exemplars を参照します
• Code_Exemplars と copilot-instructions から取得します

ライセンス

• 利用可能な場合、ライセンス情報を含めます

README を適切なマークダウン形式でフォーマットします。以下を含めます:

• 明確な見出しと小見出し
• 必要に応じてコードブロック
• 可読性向上のためのリスト
• 他のドキュメントファイルへのリンク
• 利用可能な場合、ビルドステータスやバージョンなどのバッジ

README は簡潔でありながら情報量が多いものにしていきます。新しい開発者またはユーザーがプロジェクトについて知る必要があることに焦点を当てます。