Skip to content

Commit 404a690

Browse files
feat: update readme
1 parent 0d60fba commit 404a690

1 file changed

Lines changed: 8 additions & 9 deletions

File tree

examples/workflows/pr-review/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This document explains how to use the Gemini CLI on GitHub to automatically revi
3434

3535
## Overview
3636

37-
The PR Review workflow uses Google's Gemini AI to provide comprehensive code reviews for pull requests. It analyzes code quality, security, performance, and maintainability while providing constructive feedback in a structured format.
37+
The PR Review workflow uses Google's Gemini AI and [code review extension](https://github.com/gemini-cli-extensions/code-review) to provide comprehensive code reviews for pull requests. It analyzes code quality, security, performance, and maintainability while providing constructive feedback in a structured format.
3838

3939
## Features
4040

@@ -178,16 +178,15 @@ After posting all inline comments, the action submits the review with a final su
178178
The action provides specific, actionable feedback directly on the relevant lines of code in the pull request. Each comment includes:
179179

180180
- **Priority**: An emoji indicating the severity of the feedback.
181-
- 🔴 **Critical**: Must be fixed before merging (e.g., security vulnerabilities, breaking changes).
182-
- 🟠 **High**: Should be addressed (e.g., performance issues, design flaws).
183-
- 🟡 **Medium**: Recommended improvements (e.g., code quality, style).
184-
- 🟢 **Low**: Nice-to-have suggestions (e.g., documentation, minor refactoring).
185-
- 🔵 **Unclear**: Priority is not determined.
181+
- **Critical**: Must be fixed before merging (e.g., security vulnerabilities, breaking changes).
182+
- **High**: Should be addressed (e.g., performance issues, design flaws).
183+
- **Medium**: Recommended improvements (e.g., code quality, style).
184+
- **Low**: Nice-to-have suggestions (e.g., documentation, minor refactoring).
186185
- **Suggestion**: A code block with a suggested change, where applicable.
187186

188187
**Example Inline Comment:**
189188

190-
> 🟢 Use camelCase for function names
189+
> Use camelCase for function names
191190
>
192191
> ```suggestion
193192
> myFunction
@@ -216,15 +215,15 @@ You can customize the workflow by modifying:
216215
217216
### Review Prompt Customization
218217
219-
The review prompt is defined in the `gemini-review.toml` file. The action automatically copies this file from `.github/commands/` to `.gemini/commands/` during execution.
218+
The review prompt utilize [code review extension](https://github.com/gemini-cli-extensions/code-review) and its defined prompt.
220219
221220
**To customize the review prompt:**
222221
223222
1. Copy the TOML file to your repository:
224223
225224
```bash
226225
mkdir -p .gemini/commands
227-
curl -o .gemini/commands/gemini-review.toml https://raw.githubusercontent.com/google-github-actions/run-gemini-cli/main/examples/workflows/pr-review/gemini-review.toml
226+
curl -o .gemini/commands/gemini-review.toml https://raw.githubusercontent.com/gemini-cli-extensions/code-review/main/commands/code-review.toml
228227
```
229228
230229
2. Edit `.gemini/commands/gemini-review.toml` to customize:

0 commit comments

Comments
 (0)