リポジトリ品質確認プロンプト
リポジトリ全体の品質確認をチェックリスト形式で行うためのプロンプトです。
想定用途
- リポジトリ全体の品質確認
- README.mdの品質チェック
- ドキュメント一貫性の確認
- 環境設定とセキュリティの確認
- コード品質のチェック
- プロジェクト構造の評価
プロンプト本文
text
# リポジトリ品質確認プロンプト
あなたは優れたコードレビューとリポジトリ構造分析の専門家です。以下のチェックリストに沿って、リポジトリ全体の品質確認を行ってください。各項目について「✅」（問題なし）、「❌」（問題あり）、「⚠️」（一部問題あり）のいずれかで評価し、問題がある場合は具体的な改善提案を提示してください。
## チェックリスト
### 📝 README.md の品質確認
- [ ] タイトルは中央揃えになっているか
- [ ] ヘッダー画像は中央揃えになっているか
- [ ] 技術スタックのバッジが適切に配置され、中央揃えになっているか
- [ ] 各セクションに絵文字が活用され、可読性が向上しているか
- [ ] 目次が存在し、適切にリンクされているか
- [ ] インストール手順が明確に記載されているか
- [ ] 使用方法が明確に記載されているか
- [ ] スクリーンショットや図が適切に使用されているか
### 📚 ドキュメンテーション全体の一貫性
- [ ] 各階層のマークダウンファイル（README.md, CONTRIBUTING.md, docs/ など）の内容に重複がないか
- [ ] 全てのドキュメントで一貫した用語が使用されているか
- [ ] リポジトリ全体でのドキュメントの構造が論理的か
### 🔒 環境設定とセキュリティ
- [ ] `.env` や環境変数が適切に使用されているか
- [ ] 直接コード内にAPIキーやパスワードなどの機密情報が記載されていないか
- [ ] `.gitignore` ファイルに `.env` が適切に記載されているか
- [ ] `.env.example` が存在し、必要な環境変数の例が記載されているか
### 💻 コード品質
- [ ] コードコメントは適切に記載されているか
- [ ] 命名規則が一貫しているか
- [ ] 未使用のコードやコメントアウトされたコードが放置されていないか
- [ ] テストが適切に記述され、実行可能か
### 📂 プロジェクト構造
- [ ] フォルダ構造が論理的で理解しやすいか
- [ ] 依存関係が適切に管理されているか
## 出力形式
以下のような形式でチェックリストの結果を出力してください：
### 📝 README.md の品質確認
- [✅/❌/⚠️] タイトルは中央揃えになっているか
- 問題点と改善提案（問題がある場合）
- [✅/❌/⚠️] ヘッダー画像は中央揃えになっているか
- 問題点と改善提案（問題がある場合）
- ...（以下同様）
### 📚 ドキュメンテーション全体の一貫性
- [✅/❌/⚠️] 各階層のマークダウンファイルの内容に重複がないか
- 問題点と改善提案（問題がある場合）
- ...（以下同様）
（他のセクションも同様の形式で）
### 🔍 総評
リポジトリの現在の状態に関する簡潔な総評と、優先して対応すべき最重要の改善点3つを提示してください。
### 📝 具体的な修正例
最も重要な改善点について、具体的なコードやマークダウンの修正例を提示してください。
---
このチェックリストに沿って、リポジトリ全体を分析し、開発サイクルのクロージング処理として必要な改善点を明確にしてください。使い方
- プロンプトをAIに貼り付け
- チェックしたいリポジトリの情報を提供
- チェックリストに沿った評価を受け取る
入力例
リポジトリのURLまたはファイル構造を提供するだけで、チェックリストに沿った評価が行われます。
出力例
各チェック項目の評価結果（✅/❌/⚠️）と、問題がある場合は具体的な改善提案が提供されます。
バージョンとの違い
- V1: 基本的なチェックリスト
- V2: README階層構造確認の強化
- V3: 日英バイリンガル対応
- V4: さらに高度なチェック項目
注意点
- README.mdの品質に特に注意して確認してください
- ドキュメントの重複を避けることが重要です