# GitHub コード品質 のクイックスタートガイド

コード品質の結果を確認し、 Copilot Autofixを生成し、pull request をマージして、信頼性と保守性を GitHub Code Qualityで向上させます。

## イントロダクション

```
          GitHub Code Quality (パブリック プレビュー) は、pull request と既定のブランチでコード品質の結果を表示することで、コードの信頼性と保守性を維持するのに役立ちます。
```

このチュートリアルでは、リポジトリのコード正常性を向上させるために役立つ、既定のブランチでコード品質の検出を識別して修正する方法について説明します。

### \[前提条件]

* ```
          GitHub Code Quality リポジトリに対して有効になっている必要があり、サポートされている言語のコードが必要です。 「[AUTOTITLE](/code-security/code-quality/how-tos/enable-code-quality)」を参照してください。
  ```
* ```
          GitHub Code Qualityを初めて有効にする場合は、既定のブランチの完全なCodeQL スキャンが完了するまで、有効化後数分待っていることを確認します。
  ```

## 既定のブランチのスキャン結果を確認する

リポジトリの \[ **<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-shield" aria-label="shield" role="img"><path d="M7.467.133a1.748 1.748 0 0 1 1.066 0l5.25 1.68A1.75 1.75 0 0 1 15 3.48V7c0 1.566-.32 3.182-1.303 4.682-.983 1.498-2.585 2.813-5.032 3.855a1.697 1.697 0 0 1-1.33 0c-2.447-1.042-4.049-2.357-5.032-3.855C1.32 10.182 1 8.566 1 7V3.48a1.75 1.75 0 0 1 1.217-1.667Zm.61 1.429a.25.25 0 0 0-.153 0l-5.25 1.68a.25.25 0 0 0-.174.238V7c0 1.358.275 2.666 1.057 3.86.784 1.194 2.121 2.34 4.366 3.297a.196.196 0 0 0 .154 0c2.245-.956 3.582-2.104 4.366-3.298C13.225 9.666 13.5 8.36 13.5 7V3.48a.251.251 0 0 0-.174-.237l-5.25-1.68ZM8.75 4.75v3a.75.75 0 0 1-1.5 0v-3a.75.75 0 0 1 1.5 0ZM9 10.5a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg> Security and quality** ] タブに移動し、左側のサイドバーの \[ **<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-code-review" aria-label="code review" role="img"><path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v8.5A1.75 1.75 0 0 1 14.25 13H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25v-8.5C0 1.784.784 1 1.75 1ZM1.5 2.75v8.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-8.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Zm5.28 1.72a.75.75 0 0 1 0 1.06L5.31 7l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.75.75 0 0 1 1.06 0Zm2.44 0a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042L10.69 7 9.22 5.53a.75.75 0 0 1 0-1.06Z"></path></svg>コードの品質** ] をクリックし、\[ **標準の結果** ] をクリックしてリポジトリ ダッシュボードを開きます。

次の内容が表示されます。

* コードベースの **信頼性** と **保守容易性** に関する評価。これは、コードの正常性をひとめで把握するのに役立ちます。
* 既定のブランチで\*\*\*\* を利用した分析によって検出されたすべての品質問題のCodeQL。ルールと言語別にグループ化されます。

  ![Code Quality の "標準の結果" ビューに表示されるコード品質評価のスクリーンショット。](/assets/images/help/code-quality/all-findings-overview-repo.png)

## 影響の大きい所見を特定する

```
          **ダッシュボード フィルター**を使用して、重大度レベルの高い検索 ("エラー" または "警告") を特定します。
```

これらを解決すると、リポジトリの評価に最も大きな影響を与えます。

!["標準の結果" ビューのダッシュボード フィルターを示すスクリーンショット。](/assets/images/help/code-quality/standard-findings-filters.png)

### 結果の詳細を調べる

ルール名自体をクリックすると、そのルールの影響を受けるファイルとコード行の詳細ビューが表示されます。

!["標準の結果" ビューのルールを示すスクリーンショット。 ルール名は濃いオレンジで強調表示されています。](/assets/images/help/code-quality/click-rule-name.png)

詳細ビューが表示されたら、\[ **さらに表示** ] をクリックしてコンテキストを収集し、結果を理解します。

![「上書きされたプロパティ」ルールの結果のスクリーンショットです。 テキスト "Show more" が濃いオレンジ色で強調表示されています。](/assets/images/help/code-quality/click-show-more.png)

##

```
          Copilot Autofixを生成します。
```

強調表示された検索結果の右側にある \[**修正プログラムの生成] <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-copilot" aria-label="copilot" role="img"><path d="M7.998 15.035c-4.562 0-7.873-2.914-7.998-3.749V9.338c.085-.628.677-1.686 1.588-2.065.013-.07.024-.143.036-.218.029-.183.06-.384.126-.612-.201-.508-.254-1.084-.254-1.656 0-.87.128-1.769.693-2.484.579-.733 1.494-1.124 2.724-1.261 1.206-.134 2.262.034 2.944.765.05.053.096.108.139.165.044-.057.094-.112.143-.165.682-.731 1.738-.899 2.944-.765 1.23.137 2.145.528 2.724 1.261.566.715.693 1.614.693 2.484 0 .572-.053 1.148-.254 1.656.066.228.098.429.126.612.012.076.024.148.037.218.924.385 1.522 1.471 1.591 2.095v1.872c0 .766-3.351 3.795-8.002 3.795Zm0-1.485c2.28 0 4.584-1.11 5.002-1.433V7.862l-.023-.116c-.49.21-1.075.291-1.727.291-1.146 0-2.059-.327-2.71-.991A3.222 3.222 0 0 1 8 6.303a3.24 3.24 0 0 1-.544.743c-.65.664-1.563.991-2.71.991-.652 0-1.236-.081-1.727-.291l-.023.116v4.255c.419.323 2.722 1.433 5.002 1.433ZM6.762 2.83c-.193-.206-.637-.413-1.682-.297-1.019.113-1.479.404-1.713.7-.247.312-.369.789-.369 1.554 0 .793.129 1.171.308 1.371.162.181.519.379 1.442.379.853 0 1.339-.235 1.638-.54.315-.322.527-.827.617-1.553.117-.935-.037-1.395-.241-1.614Zm4.155-.297c-1.044-.116-1.488.091-1.681.297-.204.219-.359.679-.242 1.614.091.726.303 1.231.618 1.553.299.305.784.54 1.638.54.922 0 1.28-.198 1.442-.379.179-.2.308-.578.308-1.371 0-.765-.123-1.242-.37-1.554-.233-.296-.693-.587-1.713-.7Z"></path><path d="M6.25 9.037a.75.75 0 0 1 .75.75v1.501a.75.75 0 0 1-1.5 0V9.787a.75.75 0 0 1 .75-.75Zm4.25.75v1.501a.75.75 0 0 1-1.5 0V9.787a.75.75 0 0 1 1.5 0Z"></path></svg>** クリックします。

![\[修正の生成\] ボタンのスクリーンショット。](/assets/images/help/code-quality/generate-fix.png)

推奨される修正プログラムを確認し、\[ **pull request を開く**] をクリックします。

### 修正プログラムをマージする

下書きの pull request を慎重に確認します。 提案された変更に満足していて、すべてのチェックとテストが成功している場合は、プル要求をマージします。

## メトリックの変更を観察する

```
          Code Quality ダッシュボード ([**<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-shield" aria-label="shield" role="img"><path d="M7.467.133a1.748 1.748 0 0 1 1.066 0l5.25 1.68A1.75 1.75 0 0 1 15 3.48V7c0 1.566-.32 3.182-1.303 4.682-.983 1.498-2.585 2.813-5.032 3.855a1.697 1.697 0 0 1-1.33 0c-2.447-1.042-4.049-2.357-5.032-3.855C1.32 10.182 1 8.566 1 7V3.48a1.75 1.75 0 0 1 1.217-1.667Zm.61 1.429a.25.25 0 0 0-.153 0l-5.25 1.68a.25.25 0 0 0-.174.238V7c0 1.358.275 2.666 1.057 3.86.784 1.194 2.121 2.34 4.366 3.297a.196.196 0 0 0 .154 0c2.245-.956 3.582-2.104 4.366-3.298C13.225 9.666 13.5 8.36 13.5 7V3.48a.251.251 0 0 0-.174-.237l-5.25-1.68ZM8.75 4.75v3a.75.75 0 0 1-1.5 0v-3a.75.75 0 0 1 1.5 0ZM9 10.5a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg> Security and quality**] タブに戻り、[**<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-code-review" aria-label="code review" role="img"><path d="M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v8.5A1.75 1.75 0 0 1 14.25 13H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25v-8.5C0 1.784.784 1 1.75 1ZM1.5 2.75v8.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-8.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Zm5.28 1.72a.75.75 0 0 1 0 1.06L5.31 7l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.75.75 0 0 1 1.06 0Zm2.44 0a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042L10.69 7 9.22 5.53a.75.75 0 0 1 0-1.06Z"></path></svg>コードの品質**]、[**標準の結果**] の順に選択します)。
```

次のスキャンが完了するまで数分待ちます。 Code Quality スキャンは、既定のブランチにプッシュされるたびに自動的に再実行されます。

ダッシュボードの上部にあるメトリックの変化を確認します。

* "信頼性" または "保守容易性" の **結果の数** が減少している必要があります。
* 多数の重要な指摘事項に対処した場合、"信頼性" または "保守容易性" に対する評価が向上している可能性があります。

  評価の計算方法の詳細については、 [メトリックと評価のリファレンス](/ja/code-security/code-quality/reference/metrics-and-ratings) を参照してください。

## Conclusion

リポジトリのコード正常性を向上させるために、 Code Quality と Copilot Autofix を正常に使用できました。

正常なコードは、コード品質の問題をより簡単に理解、維持、拡張、および修復できるため、コードベースの信頼性が向上し、準拠しており、将来の開発が高速化されます。

## 次のステップ

* コード品質の問題が既定のブランチに到達するのを防ぐために、pull request で GitHub Code Quality がどのように機能するかを説明します。 「[プルリクエストをマージする前にコード品質に関する指摘を修正すること](/ja/code-security/code-quality/tutorials/fix-findings-in-prs)」を参照してください。
* ```
          GitHub Code Qualityディスカッションで[](https://github.com/orgs/community/discussions/177488)に関するフィードバックを提供します。
  ```