product-example 2 linked patterns checked
GitHub Docs: Commenting on a pull request
Documents general pull request comments, line and file comments, replies to existing comments, formatting with mentions and reactions, single comments versus batched review comments, notifications, resolving conversations, and navigation by unresolved, resolved, and outdated conversation status.
Read with a purpose
What this source can teach
Use this source to inspect a concrete implementation and the decisions visible in its context.
- Start with the original. Open the source and find the guidance or example relevant to your task.
- Trace the connection. Use the claim notes below to see how this site applies the source to specific patterns.
- Check the setting. Compare the source's platform, people, and constraints with your own decision.
Pattern Decisions This Source Supports
| Pattern | Supported decision | Required contract | Claim note |
|---|---|---|---|
| Change review | Choose change review when users are inspecting proposed edits, diffs, suggestions, tracked changes, or review comments before accepting, rejecting, applying, or requesting changes. | Selecting a change reveals the base content, proposed content, author, context, and exact scope affected by a decision. | GitHub documents pull request comments, line and file comments, suggestion blocks, batched review comments, notifications, and resolved or outdated conversations. |
| Comments | Choose comments when the core object needs attached discussion, review feedback, annotation, or follow-up notes that remain separate from the object's primary editable content. | Submitting a comment creates a durable item with stable ID, author, timestamp, body, anchor, visibility scope, and notification behavior. | GitHub supports object and line comments, replies, batching, notifications, reactions, resolving conversations, and conversation status navigation. |
Comparisons supported by this source
- Comments vs textarea vs feed vs activity log
GitHub supports object and line comments, replies, batching, notifications, reactions, resolving conversations, and conversation status navigation.
Evidence Role
This source is treated as product-example evidence. Its value comes from the specific claims and setting described above.
Publisher: GitHub Docs. Last checked: .