Getting Started Overview

This guide explains what Codity does and what you can expect after connecting your first repository.

What Codity Does

Codity is a code review and intelligence platform that:

  1. Connects to your repositories on GitHub, GitLab, or Azure DevOps
  2. Monitors pull requests and merge requests via webhooks
  3. Analyzes code changes using AI-powered analysis
  4. Posts review comments directly in your pull requests/merge requests
  5. Tracks metrics in a unified dashboard
  6. Generates tests when requested via comments

What Happens After Connecting a Repository

1. Webhook Registration

When you connect a repository, Codity registers a webhook with your version control system. This webhook notifies Codity when:

  • A new pull request or merge request is created
  • A pull request or merge request is updated (new commits, title changes, etc.)
  • Comments are added to pull requests or merge requests

You don't need to configure webhooks manually - Codity handles this automatically.

2. Automatic Review Triggering

When a pull request or merge request is created or updated, Codity:

  • Receives the notification
  • Fetches the code changes
  • Analyzes the changes for:
    • Security vulnerabilities
    • Functional bugs
    • Performance issues
    • Code quality concerns
    • Maintainability issues
  • Posts review comments directly in the pull request or merge request

3. Review Comments

Review comments appear in your pull requests/merge requests just like comments from human reviewers. Each comment includes:

  • Issue type and priority: Security-critical, functional-high, performance-medium, etc.
  • Description: What the issue is and why it matters
  • Code suggestion: A suggested fix (when applicable)
  • Line references: Exact lines where the issue occurs

4. Dashboard Updates

After reviews complete, metrics are updated in your dashboard:

  • Review duration (how long the review took)
  • Number of issues found
  • Issue breakdown by type and priority
  • Historical trends

What You'll See First

In Your Pull Request/Merge Request

After connecting a repository and creating a pull request, you'll see:

  1. Review comments posted automatically (usually within 1-3 minutes)
  2. A summary comment with an overview of findings
  3. Like/dislike buttons on comments for feedback

In Your Dashboard

When you log into the Codity dashboard, you'll see:

  1. Repository list: All connected repositories
  2. Recent activity: Latest reviews and their status
  3. Metrics overview: Aggregated statistics across repositories

What Codity Does NOT Do

It's important to understand Codity's boundaries:

  • Does not modify your code: Codity only analyzes and comments
  • Does not block merges: Codity provides feedback, but doesn't enforce policies
  • Does not store your source code: Only metadata and review results are stored