Development Guidelines

開発ガイドラインスキル

チーム開発に必要な2つの要素をカバーします:

1. 実装時のコーディング規約 (implementation-guide.md)
2. 開発プロセスの標準化 (process-guide.md)

前提条件

開発ガイドライン作成を開始する前に、以下を確認してください:

推奨ドキュメント

1. docs/architecture.md (アーキテクチャ設計書) - 技術スタックの確認
2. docs/repository-structure.md (リポジトリ構造) - ディレクトリ構造の確認

開発ガイドラインは、プロジェクトの技術スタックとディレクトリ構造に 基づいた具体的なコーディング規約と開発プロセスを定義します。

既存ドキュメントの優先順位

重要: docs/development-guidelines.md に既存の開発ガイドラインがある場合、 以下の優先順位に従ってください:

1. 既存の開発ガイドライン (docs/development-guidelines.md) - 最優先

   • プロジェクト固有の規約とプロセスが記載されている
   • このスキルのガイドより優先する

2. このスキルのガイド - 参考資料

   • ./guides/implementation.md: 汎用的なコーディング規約
   • ./guides/process.md: 汎用的な開発プロセス
   • 既存ガイドラインがない場合、または補足として使用

新規作成時: このスキルのガイドとテンプレートを参照 更新時: 既存ガイドラインの構造と内容を維持しながら更新

出力先

作成した開発ガイドラインは以下に保存してください:

docs/development-guidelines.md

クイックリファレンス

コード実装時

コード実装時のルールと規約: ./guides/implementation.md

含まれる内容:

• Python規約（Python 3.12+）
• 型定義・命名規則（snake_case、型ヒント）
• 関数設計とエラーハンドリング（dataclass、Exception）
• コメント規約（Googleスタイルdocstring）
• セキュリティとパフォーマンス
• テストコード実装（pytest）
• リファクタリング手法

開発プロセスの参照／策定時

Git運用、テスト戦略、コードレビュー: ./guides/process.md

含まれる内容:

• 基本原則（具体例の重要性、理由説明）
• Git運用ルール（Git Flow ブランチ戦略）
• コミットメッセージとPRプロセス
• テスト戦略（ピラミッドとカバレッジ）
• コードレビューのプロセス
• 品質自動化

テンプレート

開発ガイドライン作成時: ./template.md

使用シーン別ガイド

新規開発時

1. ./guides/implementation.md で命名規則・コーディング規約を確認
2. ./guides/process.md でブランチ戦略・PR処理を確認
3. テストを先に書く（TDD）

コードレビュー時

• ./guides/process.md の「コードレビュープロセス」を参照
• ./guides/implementation.md で規約違反がないか確認

テスト設計時

• ./guides/process.md の「テスト戦略」（ピラミッド、カバレッジ）
• ./guides/implementation.md の「テストコード」（実装パターン）

リリース準備時

• ./guides/process.md の「Git運用ルール」（main へのマージ方針）
• コミットメッセージが Conventional Commits に従っているか確認

チェックリスト

• コーディング規約が具体例付きで定義されている
• 命名規則が明確である（言語別・プロジェクト固有）
• エラーハンドリングの方針が定義されている
• ブランチ戦略が決まっている（Git Flow推奨）
• コミットメッセージ規約が明確である
• PRテンプレートが用意されている
• テストの種類とカバレッジ目標が設定されている
• コードレビュープロセスが定義されている
• CI/CDパイプラインが構築されている