コンテンツにスキップ

PR でのコード品質

PR checksは新規コード、つまりプルリクエストで追加・変更した行に焦点を当てます。Aikidoはそれらの変更を自動的にスキャンし、インラインコメントを残す(またはゲートを失敗させる)ことで、品質issueがmainブランチに混入するのを防ぎます。

このガイドでは、PR / MR ChecksでのCode Qualityの設定方法を説明します。リポジトリ全体の既存コードをスキャンし、カテゴリスコア、未解決の検出結果、ホットスポットを確認したい場合は、Repository Scansを参照してください。

開始する前に、以下が揃っていることを確認してください。

Code Qualityは、Local ScanningアカウントおよびTeam Foundation Version Control (TFVC)リポジトリでは利用できません。

最初のコード品質チェックをセットアップして実行するまでには、全部で3つのステップがあります。Aikido UIでは、(サイドバーからアクセスできる)Code Qualityページ上でどの手順に従うべきかが明確に表示されます。以下では、より詳しく説明します。

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

Section titled “1. リポジトリでCode Qualityを有効にする”

Code Qualityチェックを有効にするリポジトリを選択します。

  1. Code Qualityページで**「Configure Repositories」**をクリックし、PR checksページを開きます。CIチェックをまだ設定していない場合は、インストールフローに案内されます。
  2. コード品質チェックを実行したいリポジトリを選択し、モーダル内(下部)でCode Quality機能を有効にします。コメントの追加のみとするか、ゲートも失敗させるかを選択できます。

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

  1. 以下のカテゴリに分かれた利用可能なチェックを確認します。
    • Default checks - 複数言語向けに事前設定されたベストプラクティス
    • Custom checks - チーム固有のルール(後から追加可能)
  2. チームのニーズに応じてチェックのオン/オフを切り替えます

リポジトリとチェックの設定が完了したら:

  1. 設定済みのリポジトリのいずれかで新しいプルリクエストを作成するか、既存のプルリクエストに新しいコミットをpushします。これにより最初のCode Qualityスキャンが自動的にトリガーされます。
  2. Activityタブで結果を確認します。