Quickstart Guide

Get your first repository connected and reviewed in 5 minutes.

Prerequisites

  • A repository on GitHub, GitLab, or Azure DevOps
  • Admin access to the repository (to install apps or configure webhooks)
  • An account on Codity (or access to your organization's Codity instance)

Step 1: Sign In

  1. Navigate to your Codity dashboard
  2. Sign in using your GitHub, GitLab, or Azure DevOps account
  3. You'll be redirected to your provider for authentication

Step 2: Connect Your Repository

The process varies slightly by provider:

GitHub

  1. In the Codity dashboard, click "Add Repositories"
  2. You'll be redirected to GitHub to install the Codity GitHub App
  3. Select the organization or personal account
  4. Choose which repositories to grant access to
  5. Complete the installation
  6. Return to the Codity dashboard - your repositories will appear

GitLab

  1. In the Codity dashboard, click "Enable Repositories"
  2. You'll see a list of your GitLab repositories
  3. Click "Enable" next to the repository you want to connect
  4. Codity will register a webhook automatically
  5. The repository will appear in your dashboard

Note: You may need to configure a GitLab Personal Access Token first. See GitLab Setup for details.

Azure DevOps

  1. In the Codity dashboard, click "Manage Repositories"
  2. Select your Azure DevOps organization
  3. Browse available repositories
  4. Click "Enable" next to the repository you want to connect
  5. Codity will register webhooks automatically
  6. The repository will appear in your dashboard

Note: You may need to configure an Azure DevOps Personal Access Token first. See Azure DevOps Setup for details.

Step 3: Create a Test Pull Request

  1. Go to your repository on GitHub/GitLab/Azure DevOps
  2. Create a new branch
  3. Make a small code change (add a function, fix a typo, etc.)
  4. Open a pull request or merge request

Step 4: Wait for Review

Within 1-3 minutes, Codity will:

  1. Detect the new pull request/merge request
  2. Analyze the code changes
  3. Post review comments directly in the pull request/merge request

Step 5: Review the Feedback

  1. Open your pull request/merge request
  2. Look for comments from Codity
  3. Each comment will include:
    • Issue type and severity
    • Description of the problem
    • Suggested fix (when applicable)
    • Line references

Step 6: Provide Feedback (Optional)

  • Click Like on comments that are helpful
  • Click Dislike on comments that aren't useful
  • Your feedback helps improve Codity's analysis

Verify It's Working

You can verify Codity is working by:

  1. Checking the pull request/merge request: You should see Codity comments
  2. Checking the dashboard: Your repository should show recent activity
  3. Checking webhooks (optional): In your repository settings, you should see Codity webhooks registered