For the complete documentation index, see llms.txt. This page is also available as Markdown.

PRでのコード品質

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

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

前提条件

始める前に、以下があることを確認してください:

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

はじめに

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

1

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

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

  1. クリック リポジトリを設定 コード品質ページでPRチェックページを開きます。まだCIチェックを設定していない場合は、インストール手順に進みます。

  2. コード品質チェックを実行したいリポジトリを選択し、次を有効にします コード品質スキャン.

  3. コード品質コメントの最低重大度を選択します。Aikidoは、その重大度以上の検出事項にコメントを追加します。

  4. 有効にする 未解決の品質コメントでチェックを失敗させる Aikidoが選択した重大度以上のコード品質問題を見つけた場合に、チェックを失敗させます。

2

品質チェックを選択

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

  1. 利用可能なチェックを以下の分類で参照します:

    • デフォルトチェック - 複数の言語向けに事前設定されたベストプラクティス

    • カスタムチェック - チーム固有のルール(後から追加できます)

  2. チームのニーズに応じてチェックのオン/オフを切り替えます

3

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

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

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

  2. 結果を次で確認します アクティビティ タブ。

コード品質の問題を修正すると、Aikidoはそのコメントを自動的に解決済みにします。 問題が修正された後にAikidoがコメントをどのように管理するかを学ぶ.

重大度の決まり方

各コード品質ルールには基本重大度があり、 チェック ページに表示されます。Aikidoが違反を見つけると、その基本重大度を起点にして、特定の状況に応じて調整します。結果としての検出事項の重大度は、ルールの基本重大度より高くなることも低くなることもあります。

最終更新

役に立ちましたか?