Code Quality Setup

Code Quality is currently works by adding comments on newly introduced PRs. Over time, Aikido will add support for IDE and will allow to scan the entire codebase.

Code Quality helps you maintain high standards across your codebase by automatically reviewing pull requests for common issues, best practices, and team-specific guidelines. This guide walks you through setting up Code Quality in your PR / MR Checks.

Prerequisites

Before you begin, ensure you have:

  • Access to this functionality

  • An accound connected to GitHub, Bitbucket, Gitlab or Azdo. No support for Local Scanning Accounts.

  • Admin access to your Aikido account

Getting started

There are 3 steps in total to setup and run your first code quality steps. The Aikido UI shows clearly which steps to follow on the Code Quality page (accessible from sidebar). Below a more extensive description.

1

Enable Code Quality for repositories

Choose which repositories should have Code Quality checks enabled:

  1. Click Configure Repositories on the Code Quality Page to open the PR checks page. If you haven't configured the CI checks yet, you will be taken through the installation flow.

  2. Select the repositories where you want to run code quality checks and enable the Code Quality functionality (on the bottom) in the modal. You can choose whether you just want to add comments or also fail the gate.

2

Select quality checks

Configure which code quality rules to enforce on the Code Quality Checks page

  1. Browse through the available checks organized by:

    • Default checks - Pre-configured best practices for multiple languages

    • Custom checks - Rules specific to your team (you can add these later)

  2. Toggle checks on/off based on your team’s needs

3

Run your first scan

Once you’ve configured repositories and checks:

  1. Click Scan Last 5 PRs to analyze your most recent pull requests. This helps you validate the configuration.

  2. Review the results in the Activity tab

4

PR integration

After the initial scan, Code Quality will automatically:

  • Comment on new pull requests with found issues

Last updated

Was this helpful?