Skip to content

Commit 495b56a

Browse files
authored
docs(cursor): clarify pr-body command instructions (#7552)
docs(cursor): clarify pr-body command instructions - Reframe template rules and fix "references" typo. - Add rule: blank line after each markdown headline. - Call out removing template comments and optional "Additional Notes". Co-authored-by: thomas.watson <thomas.watson@datadoghq.com>
1 parent 42fbf06 commit 495b56a

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

.cursor/commands/pr-body.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@ Do not just blindly list every change.
55
Only include specific changes if its relevant to understand the PR changes.
66

77
Use the PR template in `.github/pull_request_template.md` as the schema:
8-
- Remove all comments
9-
- Add content to the relevant sections (remove any section that isn't relevant)
10-
- Use commit messages in the branch as a staring point
11-
- Use markdown
12-
- Use backticks for all file/path and inline code refeferences
13-
- Don't break lines unnecessarily
8+
- **IMPORTANT:** Remove all comments from the template.
9+
- Add content to the relevant sections.
10+
- Remove "Additional Notes" section if it doesn't add any value.
11+
- Use commit messages in the branch as a staring point.
12+
- Use markdown.
13+
- Use backticks for all file/path and inline code references.
14+
- Don't break lines unnecessarily.
15+
- Add an empty line after each markdown headline, before the text.
1416

1517
**IMPORTANT:** Output the final PR body in a code block formatted using 4 backticks, so it's easy to copy/paste even if the content itself contains 3 backticks in a row.

0 commit comments

Comments
 (0)