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

イントロダクション

GitHub Code Quality(パブリック プレビュー) は、プルリクエストとデフォルトブランチでコード品質の結果を表示することで、コードの信頼性や保守性を維持するのを助けます。

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

[前提条件]

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

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

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

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

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

• CodeQL を利用した分析により、既定のブランチで検出されたすべての品質問題の結果一覧は、ルールおよび言語別にグループ化されています。

  

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

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

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

結果の詳細を調べる

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

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

Copilotの自動修正 を生成する

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

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

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

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

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

Code Quality ダッシュボードに戻ります (セキュリティ タブ、コードの品質、標準の結果)。

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

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

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

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

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

Conclusion

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

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

次のステップ

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