GitHub Copilot コード レビューのコーディング ガイドラインについて

コーディング ガイドラインについて

自然言語で書かれたカスタム コーディング ガイドラインを使って、Copilot コード レビュー をカスタマイズできます。 Copilot コード レビュー の詳細については、「Copilot コード レビューについて」を参照してください。

コーディング ガイドラインを使うと、Copilot は、organization の固有のコーディング スタイルとベスト プラクティスに基づいてフィードバックを提供できます。

Copilot コード レビュー は大規模言語モデルを搭載しているため、リンターまたは静的分析ツールではカバーされていないコーディング ガイドラインを適用するのに役立ちます。

コーディング ガイドラインは、リポジトリ レベルで構成されます。 リポジトリごとに最大 6 つのコーディング ガイドラインを作成して有効にできます。 「GitHub Copilot コード レビューのコーディング ガイドラインの構成」を参照してください。

Copilot にレビューを要求すると、リポジトリの有効なコーディング ガイドラインを自動的に使ってコードのレビューが行われます。

コーディング ガイドラインに基づいて生成されたコメントには、そのソースを明確に示すメッセージが含まれます。

コーディング ガイドラインについて行って良いことと悪いこと

• 良い 平易で明確で簡潔な言語を使って、コーディング ガイドラインを記述する。
• 良い Copilot が模索する必要のあるもの、つまり、コードに記述されてほしいものとほしくないものを、できるだけ具体的に指定する。
• 良い 後述する「コーディング ガイドラインの例」を見て参考にする。
• 悪い コーディング ガイドラインを使って、リンターまたは静的分析ツールで対応できるスタイル ガイドラインを適用しようとする。
• 悪い あいまいな、または何通りにも解釈できる表現を使う。
• 悪い 複数の異なるアイデアを 1 つのコーディング ガイドラインに盛り込もうとする。

コーディング ガイドラインの例

例 1: マジック ナンバーの使用を避ける

タイトル: Avoid using magic numbers

説明: Don't use magic numbers in code. Numbers should be defined as constants or variables with meaningful names.

パス パターン: **/*.py

例 2: SQL クエリで SELECT * を使用しない

タイトル: Don't use `SELECT *` in SQL queries

説明: Don't use `SELECT *` in SQL queries. Always specify the columns you want to select. `COUNT(*)` is allowed.

パス パターン: なし (SQL クエリはコードに埋め込まれる可能性があるため、すべてのファイルの種類に適用します)。

例 3: HTTP 要求に fetch を使用する

タイトル: Use `fetch` for HTTP requests

説明: Use `fetch` for HTTP requests, not `axios` or `superagent` or other libraries.

パス パターン: **/*.ts、**/*.js、**/*.jsx、**/*.tsx

例 4: 常にメトリックに現在の環境でタグを付ける

タイトル: Always tag metrics with the current environment

説明: Always include a `env` tag with the current environment when emitting metrics, for example, `env:prod` or `env:dev`.

パス パターン: */*.go、*/*.java

参考資料

• GitHub Copilot コード レビューのコーディング ガイドラインの構成