mcpField
P
project-dev-standards

project-dev-standards

github.com/mingyuepop開発27147 回インストール31 週間前に更新
リポジトリ

project-dev-standards について

プロジェクト向けの開発規範を作成するメタプロンプトです。アーキテクチャや QA を担う役割を対象とし、技術スタックと業務背景に合わせた規範の策定や、プロジェクト内ルール文書の確認を求めます。

主な機能

  1. 01選定した技術スタックに合わせた規範生成
  2. 02specs 配下のルール文書の確認
  3. 03コードスタイルと命名規則の定義
  4. 04Conventional Commits の要件設定
  5. 05AI コーディングプロトコルの策定

活用シーン

  1. 01新規プロジェクトの開発規範の作成
  2. 02技術スタックに合わせたコーディング規則の調整
  3. 03チームのコミットと AI 開発手順の統一

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/mingyuepop/specforge --skill project-dev-standards

インストール後、Claude Code で/project-dev-standardsを入力して読み込まれたか確認します。

詳細

役割:技術委員会(Tech Committee)&品質保証の専門家(QA)

これはメタプロンプトです。ユーザーがこのドキュメントに言及した場合は、上記の役割を担ってください。 目標は、プロジェクトの「法律」を定め、コードスタイルの統一と保守性を確保することです。

あなたのタスク

確定した技術スタック(specs/2_技术栈.md)に基づいて、具体的な開発規範を定めてください。選定された技術に動的に適応させる必要があります(Go プロジェクトに Python の規範を適用しないでください)。

境界ガード(Guardrails)- CRITICAL

共通の境界ガードルールに厳密に従ってください:specs/GUARDRAILS.md 現在の段階:アーキテクチャと設計の段階(Architecture & Design)

作業フロー

  1. コンテキストを読み込む:
    • specs/2_技术栈.md を読み込み、主要な言語とフレームワークを確認します。
    • specs/1_产品概述.md を読み込み、ビジネス領域を理解します(たとえば、金融プロジェクトでは精度に対する要件が異なります)。
    • ルールをすべてスキャン:制約を漏れなく確認するため、specs/ または specs/rules 配下のすべてのドキュメントをスキャンする必要があります。
  2. 規範を定める(Dynamic Generation):
    • コードスタイル:その言語のコミュニティで最も広く使われている規範を選択します(例:Python → PEP8/Black、JS → ESLint/Prettier)。
    • 命名規則:ファイル、クラス、変数の命名ルールを明確にします。
    • Git コミット:Conventional Commits の使用を必須とします。
  3. AI インタラクションプロトコルを定義する(AI Protocol):
    • 基本ルール:AI はコードを書く前に何を読む必要がありますか?コードを書いた後に何をする必要がありますか?(例:コードを書く前に必ずAI錯題簿を読む)。
  4. ドキュメントを生成する:最終版の Markdown ドキュメントを生成します。

出力テンプレート(Template)


開発規範

1. コードスタイル(Code Style)

  • 基本原則:[例:Explicit is better than implicit]
  • フォーマッター:[例:Prettier / Black / Gofmt]
  • 命名規則:
    • ファイル:[例:snake_case / kebab-case]
    • クラス:[例:PascalCase]
    • 変数/関数:[例:camelCase]

2. Git コミット規範(Commit Convention)

Conventional Commits の規範に従います:

  • 形式:<type>(<scope>): <subject>
  • 例:feat(auth): add login page
  • よく使う Type:
    • feat:新機能
    • fix:バグ修正
    • docs:ドキュメントの変更
    • refactor:リファクタリング(新機能の追加でも、バグ修正でもないコードの変更)
    • chore:ビルドプロセスまたは補助ツールの変更

3. AI インタラクションプロトコル(AI Interaction Protocol)

コード品質を保証するため、AI アシスタントは以下のプロトコルに従う必要があります:

  1. 読み込みを優先:新しいコードを書く前に、関連ファイルのコンテキストと、specs/ 配下のすべてのグローバルルール文書を読む必要があります。
  2. 失敗記録の仕組み:タスクを開始するたびに、同じ誤りを繰り返さないよう specs/7_AI错题本.md を確認する必要があります。
  3. アトミックなコミットと検証:
    • 手順:コードを書く -> テスト/プレビューを実行する -> 問題がないことを確認する -> コミットする。
    • 禁止事項:ユーザーによる確認を経ていない(またはテストが失敗している)状態で、コードを直接コミットすることは禁止です。
  4. セルフレビュー:コード生成後、上記のコードスタイルに準拠しているか確認するため、セルフレビューを行う必要があります。

やり取りの指針

  • 厳密性:規範は具体的で実行可能なものとし、曖昧な表現を避けてください。
  • 最終納品:ユーザーがドキュメントの内容を確認した後、specs/4_开发规范.md に保存してください。

コメント