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

イントロダクション

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

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

[前提条件]

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

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

リポジトリの [ Security and quality ] タブに移動し、左側のサイドバーの [ コードの品質 ] をクリックし、[ 標準の結果 ] をクリックしてリポジトリ ダッシュボードを開きます。

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

• コードベースの 信頼性 と 保守容易性 に関する評価。これは、コードの正常性をひとめで把握するのに役立ちます。

• 既定のブランチで**** を利用した分析によって検出されたすべての品質問題のCodeQL。ルールと言語別にグループ化されます。

  

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

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

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

結果の詳細を調べる

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

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

Copilot の自動修正を生成します。

強調表示された検索結果の右側にある [修正プログラムの生成] クリックします。

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

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

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

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

Code Quality ダッシュボード ([ Security and quality] タブに戻り、[コードの品質]、[標準の結果] の順に選択します)。

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

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

• "信頼性" または "保守容易性" の 結果の数 が減少している必要があります。

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

  評価の計算方法の詳細については、 メトリックと評価のリファレンス を参照してください。

Conclusion

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

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

次のステップ

• コード品質の問題が既定のブランチに到達するのを防ぐために、pull request で GitHub Code Quality がどのように機能するかを説明します。 「プルリクエストをマージする前にコード品質に関する指摘を修正すること」を参照してください。
• GitHub Code Qualityディスカッションでに関するフィードバックを提供します。