Skip to content

Commit 191cdfd

Browse files
committed
CLDSRV-880 Fix markdown lint errors in review-pr skill
Wrap long lines to stay under 80 chars (MD013) and use four-backtick fence for the heredoc example so inner suggestion fences don't trigger MD031.
1 parent e04ea4a commit 191cdfd

File tree

1 file changed

+33
-10
lines changed

1 file changed

+33
-10
lines changed

.claude/skills/review-pr/SKILL.md

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,33 @@ Parse `$ARGUMENTS` to extract the repo and PR number:
8686
8787
#### Part A: Inline file comments
8888
89-
For each issue, post a comment on the exact file and line. Keep comments short (1-3 sentences), end with `— Claude Code`. Use line numbers from the **new version** of the file.
89+
For each issue, post a comment on the exact file and
90+
line. Keep comments short (1-3 sentences), end with
91+
`— Claude Code`. Use line numbers from the **new
92+
version** of the file.
93+
94+
**Without suggestion block** — single-line command,
95+
`<br>` for line breaks:
9096
91-
**Without suggestion block** — single-line command, `<br>` for line breaks:
9297
```bash
93-
gh api -X POST -H "Accept: application/vnd.github+json" "repos/<owner/repo>/pulls/<number>/comments" -f body="Issue description.<br><br>— Claude Code" -f path="file" -F line=42 -f side="RIGHT" -f commit_id="<headRefOid>"
98+
gh api -X POST \
99+
-H "Accept: application/vnd.github+json" \
100+
"repos/<owner/repo>/pulls/<number>/comments" \
101+
-f body="Issue description.<br><br>— Claude Code" \
102+
-f path="file" -F line=42 \
103+
-f side="RIGHT" -f commit_id="<headRefOid>"
94104
```
95105

96-
**With suggestion block** — use a heredoc (`-F body=@-`) so code renders correctly:
97-
```bash
98-
gh api -X POST -H "Accept: application/vnd.github+json" "repos/<owner/repo>/pulls/<number>/comments" -F body=@- -f path="file" -F line=42 -f side="RIGHT" -f commit_id="<headRefOid>" <<'COMMENT_BODY'
106+
**With suggestion block** — use a heredoc
107+
(`-F body=@-`) so code renders correctly:
108+
109+
````bash
110+
gh api -X POST \
111+
-H "Accept: application/vnd.github+json" \
112+
"repos/<owner/repo>/pulls/<number>/comments" \
113+
-F body=@- -f path="file" -F line=42 \
114+
-f side="RIGHT" \
115+
-f commit_id="<headRefOid>" <<'COMMENT_BODY'
99116
Issue description.
100117
101118
```suggestion
@@ -105,16 +122,22 @@ second line of suggested code
105122
106123
— Claude Code
107124
COMMENT_BODY
108-
```
125+
````
109126

110-
Only suggest when you can show the exact replacement. For architectural or design issues, just describe the problem.
127+
Only suggest when you can show the exact replacement.
128+
For architectural or design issues, just describe the
129+
problem.
111130

112131
#### Part B: Summary comment
113132

114-
Single-line command, `<br>` for line breaks. No markdown headings — they render as giant bold text. Flat bullet list only:
133+
Single-line command, `<br>` for line breaks. No markdown
134+
headings — they render as giant bold text. Flat bullet
135+
list only:
115136

116137
```bash
117-
gh pr comment <number> --repo <owner/repo> --body "- file:line — issue<br>- file:line — issue<br><br>Review by Claude Code"
138+
gh pr comment <number> --repo <owner/repo> \
139+
--body "- file:line — issue<br>\
140+
- file:line — issue<br><br>Review by Claude Code"
118141
```
119142

120143
If no issues: just say "LGTM". End with: `Review by Claude Code`

0 commit comments

Comments
 (0)