Home/Help
Documentation
Help & documentation
PR Clarity posts structured pull request summaries on GitHub. Use these guides to install the app, read the comment format, add repository rules, and understand our data practices.
Topics
Getting started
Install the app, which events trigger a new summary, and what to expect on first run.
Anatomy of a PR comment
What each section of the summary means, including optional blocks like custom rules and notes.
Custom rules
Define .prclarityrc JSON: path, patch, and size rules with examples and schema limits.
Privacy policy
Full policy: GDPR legal bases, data categories, sub-processors, transfers, retention, and your rights.
Not installed yet?
Add the GitHub App to a repository in two clicks.