カスタム指示

チーム向けカスタム指示の構築

標準化されたプロジェクト指示を作成することで、すべてのチームメンバーが一貫したガイドラインの中で作業することが保証されます。まず、プロジェクトの技術的基盤を文書化し、次にどの情報を指示に含める必要があるかを特定します。正確な範囲はチームのニーズによって異なりますが、一般的には可能な限り多くの情報を提供することが最善です。すべてのチームメンバーが従う包括的な指示を作成することで、プロジェクト全体でコードをどのように記述、テスト、デプロイするかについての共通理解が確立され、より保守性が高く一貫性のあるソフトウェアが実現します。

---

チームのカスタム指示に含めるべきトピックと例をいくつか示します：

1. テストフレームワークと特定のコマンド
   • 「すべてのコンポーネントには、少なくとも85%のカバレッジを持つJestテストを含める必要があります。プルリクエストを送信する前に、npm run test:coverageを使用してテストを実行してください。」
2. 明示的なライブラリの選好
   • 「データ取得と状態管理にはReact Queryを使用してください。複雑なグローバル状態に特別に必要な場合を除き、Reduxは避けてください。スタイリングには、src/styles/theme.jsにあるカスタムテーマ設定でTailwind CSSを使用してください。」
3. ドキュメントの場所
   • 「すべてのAPIドキュメントは、「Engineering > API Reference」の下にある内部Notionワークスペースで利用できます。コンポーネント使用例については、https://storybook.internal.company.comのStorybookインスタンスを参照してください。」
4. 使用するMCPサーバーとその目的
   • 「データベース操作には、「Development > Database」の下に1Passwordに保存されている認証情報を使用して、Postgres MCPサーバーを使用してください。デプロイメントには、IAMからのデプロイメントロールを必要とするAWS MCPサーバーを使用してください。設定手順については、docs/mcp-setup.mdを参照してください。」
5. プロジェクト固有のコーディング規約
   • 「すべてのReactコンポーネントにはPascalCaseを使用し、すべてのヘルパー関数にはcamelCaseを使用してください。コンポーネントは、タイプ別ではなく機能別に整理されたsrc/componentsディレクトリに配置してください。prop定義には常にTypeScriptインターフェースを使用してください。」