Openai MCP

🚀 MCP コード規範

MCPコード規範は、プロジェクトの高品質、一貫性、および保守性を確保し、開発効率とチーム協力を向上させるために設計されています。

🚀 クイックスタート

このコード規範を適用することで、開発者は一貫したコーディングスタイルを維持し、プロジェクトの品質と保守性を向上させることができます。

✨ 主な機能

• 基本的なコーディング規則を提供し、コードの一貫性を保つ。
• 高度な規範を含み、依存関係管理、テスト、ドキュメント作成などを支援する。
• コードレビュー、デプロイ、プロジェクトメンテナンスのためのガイドラインを提供する。

📚 ドキュメント

基本規則

1. 命名規則:

   • 変数と関数名はスネークケース（snake_case）を使用する必要があります。
   • クラス名はパスカルケース（PascalCase）を使用します。
   • 定数はすべて大文字で、単語間はアンダースコアで区切ります（UPPER_SNAKE_CASE）。

2. コードフォーマット:

   • 各関数またはクラスの前後には、機能を説明するコメントが必要です。
   • コードブロックのインデントには4つのスペースを使用します。
   • 行の長さは120文字を超えないようにし、必要に応じて折り返します。
   • タブ文字の使用は禁止されており、インデントにはスペースを統一して使用します。

3. ファイル構造:

   • 各ファイルにはモジュールレベルのドキュメント文字列が必要です。
   • 関連する関数とクラスは論理的にグループ化し、各グループの間には1行の空行を入れて区切ります。
   • モジュールをインポートした後には1行の空行を入れます。

4. コメント:

   • 重要なロジックにはブロックコメントを追加して説明します。
   • プライベートメソッドの前には、用途を説明するコメントを追加します。
   • コメントとコードの間には少なくとも1行の空行を入れて区切ります。

5. 例外処理:

   • すべての例外が発生する可能性のある場所には、try-exceptブロックが必要です。
   • カスタム例外はBaseExceptionを継承し、個別のファイルに配置します。
   • 例外情報にはエラーコードと詳細な説明を含めます。

6. ログ記録:

   • loggingモジュールを使用してログを記録します。
   • ログレベルはDEBUG、INFO、WARNING、ERROR、CRITICALに分けられます。
   • 重要な操作にはINFO以上のログを記録します。

高度な規範

1. 依存関係管理:

   • すべてのサードパーティライブラリはpipenvまたはpoetryを使用して管理します。
   • 環境ファイル（例：Pipfile）には、プロジェクトのすべての依存関係を含める必要があります。
   • 開発版の依存関係を直接インストールすることは禁止されています。

2. テスト要件:

   • 各機能モジュールにはユニットテストが必要です。
   • テストケースはすべての主要なコードパスをカバーする必要があります。
   • pytestを使用してテストを実行し、カバレッジレポートを出力します。

3. ドキュメント作成:

   • プロジェクトには完全なAPIドキュメントとユーザーマニュアルが提供されます。
   • ドキュメントはSphinxまたは同様のツールを使用して生成します。
   • 各モジュール、クラス、関数には詳細なdoctringが必要です。

4. バージョン管理:

   • Gitを使用してバージョン管理を行います。
   • コミットメッセージはConventional Commits規範に従います。
   • プロジェクトには明確なブランチ戦略とマージフローがあります。

コードレビュー

1. 提出前のチェック:

   • lintツールを実行してコードフォーマットをチェックします。
   • ユニットテストを実行してすべてのテストケースが通過することを確認します。
   • 機密情報が公開されていないことを確認します。

2. コードスタイル:

   • PEP8およびGoogle Python Style Guideに従います。
   • コードをシンプルに保ち、複雑なロジックを避けます。
   • コードの可読性と保守性に配慮します。

3. セキュリティ規範:

   • 入力検証：すべての外部入力は検証する必要があります。
   • アクセス制御：機密操作には権限チェックが必要です。
   • セキュリティホールはすぐに修正し、依存関係を更新します。

デプロイ要件

1. 環境準備:

   • 本番環境と開発環境が一致することを確認します。
   • 環境変数を使用して異なる環境設定を管理します。
   • コンテナ化デプロイ（Docker）を使用します。

2. 設定管理:

   • AnsibleまたはChefを使用して設定管理を行います。
   • 設定ファイルをバージョン管理し、ハードコーディングを避けます。
   • 動的設定とホットリロードをサポートします。

3. 監視とアラート:

   • Prometheus監視システムをデプロイします。
   • 適切なアラート閾値を設定します。
   • ログ分析ツールを提供します。

プロジェクトメンテナンス

1. コードベース管理:

   • 定期的に不要なコードと依存関係をクリーンアップします。
   • 技術的負債を処理し、コード品質を維持します。
   • プロジェクトの保守性と拡張性を維持します。

2. バージョンリリース:

   • セマンティックバージョニング（SEMVER）を使用します。
   • リリース前にCHANGELOGを更新します。
   • アップグレードガイドと移行説明を提供します。

3. コミュニティ貢献:

   • 外部開発者のコード貢献を歓迎します。
   • 明確な貢献プロセスと規範を設定します。
   • 良好なオープンソースコミュニティ関係を維持します。