日本語

PRでのコード品質

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

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

前提条件

開始する前に、次のものがあることを確認してください：

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

はじめに

最初のCode Quality設定と実行には、全部で3つの手順があります。AikidoのUIは、Code Qualityページ（サイドバーからアクセス可能）で次に従うべき手順を明確に示します。以下では、より詳しく説明します。

  1. リポジトリでCode Qualityを有効にする

    Code Qualityチェックを有効にするリポジトリを選択してください：

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

  2. 品質チェックを選択

    Code Quality Checksページで適用するコード品質ルールを設定します

    1. 次の項目で整理された利用可能なチェックを閲覧します：
      • デフォルトのチェック ・複数言語向けの事前設定されたベストプラクティス
      • カスタムチェック ・チーム固有のルール（後で追加できます）
    2. チームのニーズに応じてチェックをオン/オフ切り替えします

  3. 最初のスキャンを実行する

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

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

Code Qualityの問題を修正すると、Aikidoはコメントを自動的に解決済みにします。 問題を修正した後にAikidoがコメントをどう管理するかを確認する.

アップロードされたテストカバレッジが一定割合を下回るとプルリクエストを失敗させるには、 コードカバレッジのPRゲーティング。その設定は同じ コード品質スキャン セクション。

重大度の決定方法

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