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