Help & Documentation

Hosted Solution Coming Soon

We're working on a hosted version of PR Cat that will eliminate the need for self-hosting. In the meantime, you can deploy your own instance using our open source code.

Deploy Your Own Get Notified

Quick Start Guide

Get up and running with PR Cat in minutes

Connect GitHub

Install the PR Cat GitHub App on your organization and grant access to repositories you want to analyze.

Configure Categories

Set up investment areas and categories that match your team's focus areas and business priorities.

Configure AI Provider

Set up your AI provider (OpenAI, Google Gemini, or Anthropic Claude) in Settings to enable automatic PR categorization.

Features Overview

Understand what each section of the dashboard provides

Team Dashboard

Team-focused retrospective metrics with weekly/bi-weekly views and team performance insights

Lifecycle

PR lifecycle analysis and workflow optimization insights

Analytics

Deep dive analytics, trends, and performance metrics

Repositories

Repository-specific insights and webhook management

AI Categorization

How PR Cat automatically categorizes your pull requests

What gets analyzed:

PR Title & Description: Natural language understanding of what the PR does
File Changes: Analysis of modified files and code patterns
Commit Messages: Understanding of the development intent

AI Providers:

OpenAI GPT-4Google GeminiAnthropic Claude

PR Cat uses multiple AI providers for robust categorization with automatic fallback.

Key Metrics Explained

Understanding the metrics and what they mean for your team

Cycle Time

Time from PR creation to merge. Lower is generally better for team velocity.

Review Coverage

Percentage of PRs that receive at least one review before merging.

PR Size

Lines of code changed. Smaller PRs are typically easier to review and less risky.

Collaboration Index

Measures how well team members collaborate through code reviews.

Webhooks & Integration

How PR Cat integrates with your GitHub workflow

Automatic Processing:

• PRs are automatically categorized when opened
• Categories are updated when PR descriptions change
• Metrics are calculated in real-time as PRs are merged
• Team performance data updates continuously

Webhook Events Processed:

pull_request.openedpull_request.closedpull_request.editedpull_request_review.submitted

Troubleshooting

Common issues and how to resolve them

PRs not being categorized?

Check that the GitHub webhook is properly installed and that your organization has sufficient AI credits.

Missing repository data?

Ensure the PR Cat GitHub App has access to the repository and that webhooks are enabled.

Incorrect categories?

Review your category definitions in Settings and ensure they clearly describe the intended scope.

Get Support

Need help? Here's how to get assistance

GitHub Issues

Report bugs or request features on our GitHub repository.

Documentation

Comprehensive guides and API documentation available online.