Home/Help/PR comment

Reference

Anatomy of a PR comment

PR Clarity posts a single comment (or thread) in Markdown. Sections are stable so you can scan them quickly; some sections appear only when needed.

Core sections

  • Understanding Summary / Goal

    The top block states the high-level goal of the change in plain language. This is the fastest way to see what the author is trying to accomplish before you read the diff.

  • Conceptual Changes

    A bullet list of non-trivial behaviors, modules, or flows touched. It focuses on intent and structure rather than a file-by-file changelog.

  • System Impact

    How the change may affect runtime behavior, dependencies, or operations (for example, new async boundaries or infrastructure). Use this to judge blast radius and review depth.

  • Observation (optional)

    Sometimes present: an additional neutral note the model includes when it helps reviewers. It is not a substitute for your own review.

  • Custom Rule Findings (optional)

    If you configure .prclarityrc and a rule matches, findings appear under this heading, grouped by severity (High, Medium, Low), with file paths and evidence when available.

  • Custom Rules Configuration (optional)

    If the config file is missing, invalid, or too large, you may see a short warning here. The main summary is still posted; only custom rule evaluation is affected.

  • Note (optional)

    When patch context is truncated for size, a note explains that the summary may miss fine-grained details. Consider reviewing large diffs locally as well.

For examples of the default summary plus custom rules output, see Custom rules.