PR におけるコード品質

PR チェックは次に焦点を当てます 新しいコード。つまり、プルリクエストで追加または変更した行です。Aikido はそれらの変更を自動でスキャンし、インラインコメントを残す（またはゲートを失敗させる）ため、品質上の問題がメインブランチに入り込むのを防ぎます。

このガイドでは、PR / MR チェックでコード品質を設定する手順を説明します。 既存コード リポジトリ全体をスキャンしてカテゴリスコア、オープンな検出結果、ホットスポットを確認するには、 リポジトリスキャン.

前提条件

始める前に、以下を用意していることを確認してください。

• GitHub、Bitbucket、GitLab、または Azure DevOps Git に接続されたアカウント
• Aikido アカウントへの管理者アクセス
• Aikido に接続されたリポジトリ

コード品質は、ローカルスキャンアカウントまたは Team Foundation Version Control（TFVC）リポジトリでは利用できません。

はじめに

最初のコード品質ステップを設定して実行するには、全部で 3 つの手順があります。Aikido の UI では、コード品質ページ（サイドバーからアクセス可能）で従うべき手順が明確に表示されます。以下により詳しい説明を示します。

1

リポジトリのコード品質を有効にする

どのリポジトリでコード品質チェックを有効にするかを選択してください。

1. クリック リポジトリを設定 コード品質ページで PR チェックページを開きます。CI チェックをまだ設定していない場合は、インストールフローに進みます。
2. コード品質チェックを実行したいリポジトリを選択し、 コード品質スキャン.
3. コード品質コメントの最小重大度を選択します。Aikido は、その重大度以上の検出結果に対してコメントを追加します。
4. 有効にする オープンな品質コメントがある場合にチェックを失敗させる Aikido が選択した重大度以上のコード品質問題を見つけたときにチェックを失敗させます。

2

品質チェックを選択

コード品質チェックページで、適用するコード品質ルールを設定します

1. 利用可能なチェックを次のカテゴリで確認できます。

   • デフォルトチェック - 複数言語向けの事前設定済みベストプラクティス
   • カスタムチェック - チーム固有のルール（後から追加できます）
2. チームのニーズに応じてチェックのオン/オフを切り替えます

3

最初のスキャンを実行

リポジトリとチェックを設定したら、

1. 設定済みリポジトリのいずれかで新しいプルリクエストを作成するか、既存のプルリクエストに新しいコミットをプッシュします。これにより、最初のコード品質スキャンが自動的にトリガーされます。
2. 結果を アクティビティ タブ。

問題を修正した後にコメントがどうなるか

後続のスキャンでコード品質の検出結果が修正されたことが確認されると、Aikido は関連する PR のインラインコメントを更新します。

で AutoFix を有効にすると、Aikido はコメントスレッドを解決済みにし、GitHub 上では解決済みの会話として残して議論の履歴を保持します。GitHub ではこれには 目次 write 権限が必要です。アプリに Pull requests の write 権限がすでにある場合でも同様です。 GitHub はこの要件を公開の場で確認しています.

AutoFix がない場合、Aikido は最小権限の原則に従い、コメントを解決するためだけの 目次 write 権限は要求しません。そのため GitHub は Aikido にスレッドの解決を許可せず、Aikido は検出結果が修正された後にコメントを削除する形にフォールバックします。

重大度の決定方法

すべてのコード品質ルールには基本重大度があり、 チェック ページに表示されます。Aikido が違反を検出すると、その基本重大度から始めて、特定のコンテキストに応じて調整します。最終的な検出結果の重大度は、ルールの基本重大度より高くなることも低くなることもあります。