What you need
A GitHub account with permission to install apps on a repository or organization. PR Clarity is a GitHub App (not a personal OAuth app); you pick which repos receive the integration at install time.
- 1
Install the GitHub App
Choose the organization or account and the repositories PR Clarity should access. The app needs permission to read pull request contents and post comments.
- 2
Open or update a pull request
PR Clarity runs when GitHub sends a pull_request event for actions opened, synchronize (new commits pushed), or reopened. Other actions (for example, converted to draft only) are ignored.
- 3
Read the first comment
Within a short time, the bot comments with a structured summary: goal, conceptual changes, and system impact. New commits on the same branch trigger a fresh analysis and comment update for that PR.
Ongoing use
Every qualifying pull request in a connected repository gets an analysis. You can add a .prclarityrc file to enforce team-specific checks; see Custom rules.
Install on GitHub
Takes a few seconds. You can change repo access later in GitHub settings.