Skip to content

Commit 4be3186

Browse files
committed
Encourage concise descriptions wihtout minutiae
1 parent 06a9e89 commit 4be3186

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

‎docs/source/contributor-guide/pr_review.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,10 @@ Check that the description:
8080

8181
2. Follows the [PR template], and answers the template's questions.
8282

83-
3. Accurately describes what the PR actually does.
83+
3. Accurately describes the content of the PR, including any relevant context or background.
84+
Great descriptions have a high signal-to-noise ratio, summarizing
85+
important implementation changes without repeating technical minutiae that
86+
are already present in the code itself.
8487

8588
4. Explicitly calls out any user-facing or API changes (see
8689
[Review the Code](#review-the-code) below).

0 commit comments

Comments
 (0)