Skip to content

AGENTS.md

Latest commit

 

History

History
132 lines (104 loc) · 5.31 KB

AGENTS.md

File metadata and controls

132 lines (104 loc) · 5.31 KB

AI Plugins - 開発ガイドライン

プロジェクト概要

Claude Codeプラグインマーケットプレイスの開発プロジェクトです。チーム全体でClaude Codeの導入を加速するための事前設定されたプラグインを提供します。

リポジトリ: https://github.com/devbasex/ai-plugins

ポリシー

言語とコミュニケーション

  • すべてのAIエージェントとのやり取りは日本語で行う
  • ドキュメント、コミットメッセージ、PR説明も日本語

Git運用ルール

  • mainブランチへの直接コミット/プッシュ禁止
  • 必ずfeatureブランチを作成して作業
  • Pull Requestを通じてレビュー・マージ
  • ユーザーの許可なくPRを承認しない

セキュリティ要件

絶対にコミットしてはいけないもの:

  • APIトークン、パスワード、認証情報、秘密鍵、個人特定情報

実施すべきこと:

  • 認証情報は環境変数で管理
  • .env.exampleでテンプレートを提供
  • .gitignoreに機密ファイルを追加

最小限のコード実装

  • 要件を満たす最小限のコードのみを記述
  • 冗長な実装を避ける
  • シンプルで明確な実装を優先

マーケットプレイスの構造

ai-plugins/
├── .claude-plugin/
│   └── marketplace.json          # マーケットプレイス定義（必須）
├── plugins/
│   ├── ndf/                      # NDFプラグイン（メイン）
│   └── {plugin-name}/            # その他のプラグイン
├── docs/                         # リポジトリ知識
├── AGENTS.md                     # 共通エントリポイント
├── CLAUDE.md                     # Claude Code固有設定
├── KIRO.md                       # Kiro CLI固有設定
└── README.md                     # プロジェクト説明

ドキュメント

ドキュメント 内容
docs/project-overview.md プロジェクト概要・インストール方法
docs/plugin-development-guide.md プラグイン開発ガイド（構造、plugin.json、バージョン管理、検証）
docs/ndf-plugin-reference.md NDFプラグイン詳細リファレンス
docs/claude-code-skills-survey.md Claude Code Skills調査レポート
docs/development-history/ 開発履歴と知見
plugins/ndf/README.md NDFプラグインドキュメント

NDFプラグインについて

NDFプラグインは、このマーケットプレイスの主要プラグインです（v4.7.0）：

  • 8個の専門サブエージェント（director、data-analyst、corder、researcher、qa、debugger、devops-engineer、code-reviewer）
  • 39個のSkills（PR/コードレビューワークフロー、AIクロスレビュー (codex/gemini)、原則・ガイドライン、issue→multi-PR ワークフロー戦略、SQL最適化、データエクスポート、skill利用統計、Codex CLI連携、Playwrightシナリオテスト、Google Drive/Chat連携 等）
  • SessionStartフック（transcript保持期間自動管理 cleanupPeriodDays >= 90）
  • Stopフック（AI要約生成 + 自動Slack通知）
  • 外部AI委譲は /ndf:codex skill と corder エージェント経由で Codex CLI を呼び出し（v4.0.0 で Codex MCP サーバは廃止）

詳細は plugins/ndf/README.md および docs/ndf-plugin-reference.md を参照。

ベストプラクティス

DO（推奨）

  • コードインテリジェンスツールを活用してコード構造を理解
  • ファイル全体を読む前にシンボル概要を取得
  • セマンティックバージョニングに従う
  • 包括的なドキュメントを提供
  • 変更前にテスト
  • featureブランチで作業、PRを通じてマージ

DON'T（非推奨）

  • ファイル全体を無闇に読み込む
  • mainブランチに直接コミット
  • バージョン番号の更新を忘れる
  • ドキュメントをスキップ
  • 機密情報をコミット
  • テストをスキップ
  • ユーザーの許可なくPRを承認

Git運用フロー

ブランチ戦略

git checkout -b feature/{feature-name}  # 新機能開発
git checkout -b fix/{bug-name}          # バグ修正
git checkout -b docs/{doc-name}         # ドキュメント更新

コミットメッセージ

日本語で明確に記述：

Add: 新機能追加
Update: 既存機能の更新
Fix: バグ修正
Docs: ドキュメント更新
Refactor: リファクタリング
Test: テスト追加・修正

PR作成フロー

  1. featureブランチで作業完了
  2. 変更をコミット
  3. リモートにプッシュ
  4. GitHubでPR作成
  5. レビュー依頼
  6. ユーザーの承認後にマージ

参考リンク

検証

claude plugin validate