Skip to content

Commit 7d94f07

Browse files
fix: typo in gemini-pr-review.yml (#124)
## Summary Fix spelling errors in the gemini-pr-review workflow files Documentation: - Fix spelling of “Succinctness” in the code suggestions section - Fix spelling of “preferred” in the review comments step - Apply these corrections to both main and example gemini-pr-review workflow files
1 parent d537ec1 commit 7d94f07

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

.github/workflows/gemini-pr-review.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ jobs:
256256
This is a strict requirement as the GitHub (and other SCM's) API won't allow comments on parts of code files that are not
257257
included in the diff hunks.
258258
8. Code Suggestions in Review Comments:
259-
* Succintness: Aim to make code suggestions succinct, unless necessary. Larger code suggestions tend to be
259+
* Succinctness: Aim to make code suggestions succinct, unless necessary. Larger code suggestions tend to be
260260
harder for pull request authors to commit directly in the pull request UI.
261261
* Valid Formatting: Provide code suggestions within the suggestion field of the JSON response (as a string literal,
262262
escaping special characters like \n, \\, \"). Do not include markdown code blocks in the suggestion field.
@@ -387,7 +387,7 @@ jobs:
387387
1. Creating a pending review: Use the mcp__github__create_pending_pull_request_review to create a Pending Pull Request Review.
388388
389389
2. Adding review comments:
390-
2.1 Use the mcp__github__add_comment_to_pending_review to add comments to the Pending Pull Request Review. Inline comments are preffered whenever possible, so repeat this step, calling mcp__github__add_comment_to_pending_review, as needed. All comments about specific lines of code should use inline comments. It is preferred to use code suggestions when possible, which include a code block that is labeled "suggestion", which contains what the new code should be. All comments should also have a severity. They syntax is:
390+
2.1 Use the mcp__github__add_comment_to_pending_review to add comments to the Pending Pull Request Review. Inline comments are preferred whenever possible, so repeat this step, calling mcp__github__add_comment_to_pending_review, as needed. All comments about specific lines of code should use inline comments. It is preferred to use code suggestions when possible, which include a code block that is labeled "suggestion", which contains what the new code should be. All comments should also have a severity. They syntax is:
391391
Normal Comment Syntax:
392392
<COMMENT>
393393
{{SEVERITY}} {{COMMENT_TEXT}}

examples/workflows/pr-review/gemini-pr-review.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ jobs:
250250
This is a strict requirement as the GitHub (and other SCM's) API won't allow comments on parts of code files that are not
251251
included in the diff hunks.
252252
8. Code Suggestions in Review Comments:
253-
* Succintness: Aim to make code suggestions succinct, unless necessary. Larger code suggestions tend to be
253+
* Succinctness: Aim to make code suggestions succinct, unless necessary. Larger code suggestions tend to be
254254
harder for pull request authors to commit directly in the pull request UI.
255255
* Valid Formatting: Provide code suggestions within the suggestion field of the JSON response (as a string literal,
256256
escaping special characters like \n, \\, \"). Do not include markdown code blocks in the suggestion field.
@@ -381,7 +381,7 @@ jobs:
381381
1. Creating a pending review: Use the mcp__github__create_pending_pull_request_review to create a Pending Pull Request Review.
382382
383383
2. Adding review comments:
384-
2.1 Use the mcp__github__add_comment_to_pending_review to add comments to the Pending Pull Request Review. Inline comments are preffered whenever possible, so repeat this step, calling mcp__github__add_comment_to_pending_review, as needed. All comments about specific lines of code should use inline comments. It is preferred to use code suggestions when possible, which include a code block that is labeled "suggestion", which contains what the new code should be. All comments should also have a severity. They syntax is:
384+
2.1 Use the mcp__github__add_comment_to_pending_review to add comments to the Pending Pull Request Review. Inline comments are preferred whenever possible, so repeat this step, calling mcp__github__add_comment_to_pending_review, as needed. All comments about specific lines of code should use inline comments. It is preferred to use code suggestions when possible, which include a code block that is labeled "suggestion", which contains what the new code should be. All comments should also have a severity. They syntax is:
385385
Normal Comment Syntax:
386386
<COMMENT>
387387
{{SEVERITY}} {{COMMENT_TEXT}}

0 commit comments

Comments
 (0)