コンテンツにスキップ

リポジトリスキャン結果の理解

リポジトリスキャンが完了すると、結果はRepositoriesタブとリポジトリ詳細ページに表示されます。これらは既存のコードを反映したもの、つまり最近のPR変更だけでなく、コードベース全体にわたる未解決の品質課題を示しています。

このガイドでは、スコアの読み方、検出結果のトリアージ方法、ホットスポットの見つけ方について説明します。

Repositoriesタブには、接続されているすべてのリポジトリが一覧表示され、4つのカテゴリでスコアが表示されます。

  • Maintainability(保守性) — コードの変更や拡張のしやすさ
  • Readability(可読性) — コードの明瞭さ、命名、構造
  • Performance(パフォーマンス) — 効率性とリソース使用量
  • Reliability(信頼性) — 正確性、エラー処理、バグを生みやすいパターン

各セルには、評価ラベル、色分けされたインジケーター、数値が表示されます。ラベルはそのカテゴリにおける最も深刻度の高い未解決の検出結果を反映しており、数値はそのカテゴリの未解決の検出結果の総数です。

PR checks列は、そのリポジトリでPR checksが有効になっているかどうか(ON / OFF)を示します。PR checksは新規コードをプルリクエスト上でカバーし、リポジトリスキャンはリポジトリ全体の既存のコードをカバーします。両者は独立しているため、どちらか一方または両方を有効にできます。

カテゴリスコアを表示したCode Qualityリポジトリテーブル

追跡対象のリポジトリをクリックすると、その詳細ページが開きます。

各カテゴリの評価は、そのカテゴリにおける最も深刻度の高い未解決の検出結果に基づくものであり、問題の総数に基づくものではありません。

評価 条件
Excellent(優秀) low(低)またはinformational(情報)の検出結果のみ(medium以上はなし)
Good(良好) medium(中)の検出結果が1件以上あるが、highまたはcriticalはなし
Fair(普通) high(高)の検出結果が1件以上あるが、criticalはなし
Poor(不良) critical(重大)の検出結果が1件以上ある

検出結果は、それをトリガーしたルールに基づいてカテゴリに分類されます。デフォルトおよびカスタムの各チェックは、上記4カテゴリのいずれかに属します。低深刻度の検出結果は評価ラベルには影響しませんが、問題数には含まれます。

リポジトリ詳細ページのTrend Over Timeタブを開くと、未解決の検出結果が週ごとにどのように変化しているかを確認できます。

このチャートは検出結果を深刻度別に分割して表示するため、critical、high、medium、lowのどの優先度の品質負債が増加または減少しているかを把握できます。クリーンアップ作業の効果測定や、対応が必要な悪化傾向の特定に活用してください。

深刻度別の未解決コード品質検出結果を示すTrend Over Timeチャート

リポジトリ詳細ページのIssuesタブには、ルールごとにグループ化されたすべての未解決の検出結果が一覧表示されます。各行には以下が表示されます。

  • Type(種類) — 影響を受けるファイルの言語
  • Name(名前) — ルール名と影響を受けるファイル
  • Severity(深刻度) — グループ内で最も高い深刻度
  • Location(場所) — 問題が発生しているファイルパス
  • Fix time(修正時間) — 解決に必要な推定作業量

行をクリックすると詳細サイドバーが開きます。そこから以下が可能です。

  • TL;DRと**How do I fix it?(修正方法)**のガイダンスを読む
  • ファイル名、行番号、コードスニペットを含む**Subissues(サブ課題)**を閲覧する
  • 特定の発生箇所を詳しく確認するために**View code analysis(コード解析を表示)**を開く
  • 個々の検出結果を無視する

検出結果を手作業で修正する代わりに、Aikidoに変更を生成させることができます。AutoFixは検出結果に対する修正を生成し、その変更を含むプルリクエストを開くことができるため、自分で書くのではなくレビューしてマージするだけで済みます。

ファイル散布図(File Scatter Plot)

Section titled “ファイル散布図(File Scatter Plot)”

File Scatter Plotタブに切り替えると、コード品質のホットスポット、つまり頻繁に変更されており、かつ未解決の品質負債を抱えているファイルを可視化できます。

ファイルごとのPR活動と未解決検出結果を示すファイル散布図

各ドットはリポジトリ内の1つのファイルを表します。

  • X軸 — 過去3か月間にそのファイルを変更したPRの数
  • Y軸 — そのファイルにおける未解決のコード品質検出結果の数

チャートの右上にあるファイルがホットスポットです。活動頻度が高く、かつ品質が低いことを示しています。リファクタリングやクリーンアップ作業を計画する際は、これらを優先してください。