Skip to content

Commit ee571a7

Browse files
committed
Rewrite review.md frontmatter and fix two body typos
The frontmatter used to expose both `link` and `links`, and both `commit` and `commits`, while telling the reader inside the YAML that the pairs were mutually exclusive. Every freshly copied review file therefore started out internally self-contradictory. Keep `link` and `commit` active by default, and demote `links` / `commits` to commented-out YAML examples right below them, so a new review file is in a consistent shape from the moment it's created. The rewrite also removes the en-dash lines and uneven YAML list-marker spacing that three other review threads asked us to fix, so those threads no longer have any text to point at. Two body typos: - Insert the missing space in `insufficient,use`. - Insert the missing "to" in `evaluate the review explain how`. Addresses: - fedify-dev#765 (comment) - fedify-dev#765 (comment) - fedify-dev#765 (comment) - fedify-dev#765 (comment) - fedify-dev#765 (comment) - fedify-dev#765 (comment) - fedify-dev#765 (comment) Assisted-by: Claude Code:claude-opus-4-7
1 parent 1e4fd43 commit ee571a7

1 file changed

Lines changed: 14 additions & 13 deletions

File tree

.agents/skills/get-reviews/review.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,19 @@
22
id: REVIEW_ID
33
description: summary of the review
44
link: The link to the review on GitHub
5-
links:
6-
- If there are multiple links related to the review, list all the links.
7-
- Include links to related PR comments (issue comments) and review thread
8-
- replies that provide additional context for this review. Use the `url`
9-
- field of each comment from the fetched JSON.
10-
- `link`–`links` are mutually exclusive.
5+
# If more than one URL is relevant — related PR comments or review-thread
6+
# replies that provide additional context — use `links` instead of `link`.
7+
# Use the `url` field of each comment from the fetched JSON.
8+
# links:
9+
# - https://github.com/.../pull/123#discussion_r4567
10+
# - https://github.com/.../pull/123#discussion_r4568
1111
commit: The hash of commit after applying the review to add the comment
12-
commits:
13-
- If the review applies to multiple commits, list the hashes of the commits
14-
- after applying the review, update the list to include the new commit hash
15-
- `commit`–`commits` are mutually exclusive. `commit` and `commits` are
16-
- optional, and only used when the review is applied.
12+
# If the review was applied across multiple commits, use `commits` instead
13+
# of `commit`. Both fields are optional and only set after the review is
14+
# applied.
15+
# commits:
16+
# - abc1234
17+
# - def5678
1718
---
1819

1920
<!-- deno-fmt-ignore-file -->
@@ -49,7 +50,7 @@ Judgement
4950
- **NEEDS DISCUSSION**: If the review needs further discussion,
5051
such as about direction of the project or design choices.
5152
Try to use these words to indicate judgement status whenever possible,
52-
but if you feel they are truly insufficient,use an appropriate word
53+
but if you feel they are truly insufficient, use an appropriate word
5354
and then update this part of *SKILL.md*.
5455
5556
After the first line, explain the judgement in more detail.
@@ -112,7 +113,7 @@ Comments
112113
on the **WRONG** part, and the correct parts based on the **CORRECT** part.
113114
114115
If the review is judged as **NEEDS EVALUATION**, write the comments to
115-
evaluate the review explain how to evaluate the review, the test results,
116+
evaluate the review to explain how to evaluate the review, the test results,
116117
and the resulting application/rejection details.
117118
- If the results of the evaluation are the review is correct,
118119
write comments referring to the **CORRECT** part.

0 commit comments

Comments
 (0)