AI Agent との協働開発(Pair Programming with AI)を前提に設計された、高品質なプロジェクトテンプレートです。 セキュリティ、品質管理、そして AI とのコラボレーションを円滑にするためのワークフローがあらかじめ組み込まれています。
- 🛡️ セキュリティ & 品質管理:
- Lefthook による Git Hooks 管理。
- Gitleaks によるシークレットスキャン。
- OSV-Scanner による脆弱性スキャン。
- 🤖 AI Agent Workflows:
- AI コーディングアシスタント(Antigravity, Cursor)向けに最適化されたワークフロー定義 (
.agent/workflows/)。 - 定型タスク(コミット、リファクタリング、設計、実装計画など)をスラッシュコマンドで実行可能。
- AI コーディングアシスタント(Antigravity, Cursor)向けに最適化されたワークフロー定義 (
- 📝 ドキュメント標準:
- 開発の指針となる CONTRIBUTING.md を完備。
- ISO/IEC/IEEE 29148:2018 に準拠した要求仕様策定フローをサポート。
このテンプレートを使用してリポジトリを作成したら、以下のコマンドで Git Hooks を初期化してください。
# Install specific tools (macOS example)
brew install lefthook gitleaks osv-scanner
# Initialize Lefthook
lefthook installこのリポジトリには、AI Agent に指示を出すための「ワークフロー」が定義されています。 対応する AI エディタやエージェント(Cursor, Antigravity など)を使用している場合、以下のスラッシュコマンドでタスクを効率化できます。
| コマンド | 説明 |
|---|---|
/req |
ISO/IEC/IEEE 29148:2018 形式の要求仕様書 (docs/requirements.md) を作成 |
/design |
要求仕様に基づいた基本設計書 (docs/design.md) を作成 |
/plan_implementation |
GitHub Issue 単位の実装計画 (docs/implementation_plan.md) を立案 |
/prepare |
実装計画から次に着手すべきタスクを特定し、実装ガイドを提示 |
/start |
指定されたタスクの TDD サイクルに基づく実装を開始 |
/refactor |
振る舞いを変えずにコードの内部構造を改善 |
/commit |
変更内容を解析し Conventional Commits 形式でコミット |
/pr |
GitHub プルリクエストを作成 |
以下は、新規プロジェクトを AI Agent と協働で進める際の推奨フローです。
graph TD
A[1. /req<br/>要求仕様書の作成] --> B[2. 技術スタック定義<br/>手動作成]
B --> C[3. /design<br/>設計書の作成]
C --> D[4. /plan_implementation<br/>実装計画の立案]
D --> E[5. /prepare<br/>次のタスクを確認]
E --> F[6. /start<br/>実装開始]
F --> G{リファクタリング<br/>が必要?}
G -->|Yes| H[7. /refactor<br/>コード改善]
H --> I[8. /commit<br/>コミット]
G -->|No| I
I --> J{タスク<br/>完了?}
J -->|No| F
J -->|Yes| K[9. /pr<br/>PR 作成]
K --> L{次のタスク<br/>がある?}
L -->|Yes| E
L -->|No| M[完了]
Phase 1: 要件定義 & 設計
/req: 作りたいものの概要を伝えると、ISO/IEC/IEEE 29148 に準拠した要求仕様書のドラフトを自動生成します。- 技術スタック定義(手動):
docs/tech_stack.mdを作成し、使用する言語・フレームワーク・ライブラリを定義します。⚠️ このステップは自動化されていません。ユーザー自身で作成してください。- AI Agent に相談しながら技術選定を行うことも可能です。
- 記載例: 言語、フレームワーク、データベース、インフラ、主要ライブラリなど
/design: 要求仕様と技術スタック (docs/tech_stack.md) に基づき、アーキテクチャ概要やモジュール設計を含む設計書を作成します。/plan_implementation: 設計書から GitHub Issue として登録可能な粒度でタスクを分解し、MVP ファーストの実装計画を立案します。
Phase 2: 実装
/prepare: 実装計画 (docs/implementation_plan.md) を分析し、依存関係を考慮した上で次に着手すべきタスクを提示します。/start: Issue に対応するブランチを作成し、TDD サイクル(Red → Green → Refactor)に従って実装を進めます。/refactor: 必要に応じて、テストを壊さない範囲でコードを改善します。
Phase 3: コミット & PR
/commit: 変更内容を自動解析し、Conventional Commits 形式のコミットメッセージを生成してコミットします。/pr: PR テンプレートに従ってプルリクエストを作成します。
既存のプロジェクトに途中から適用する場合も、以下のコマンドは単体で利用できます。
/commit: 日常的なコミット作業の効率化に/refactor: コードベースの段階的な改善に/pr: PR 作成作業の自動化に