ef02d20086
Let gemini always add pr title and commit message summary.
- vLLM version: v0.14.1
- vLLM main:
dc917cceb8
Signed-off-by: wangxiyuan <wangxiyuan1007@gmail.com>
91 lines
2.8 KiB
Markdown
91 lines
2.8 KiB
Markdown
# Pull Request Summary Style Guide
|
|
|
|
## Output Instructions
|
|
|
|
**IMPORTANT**: When doing PR review, you MUST output them in markdown code blocks so users can easily copy them:
|
|
|
|
1. **PR Title**: Output the generated title in a code block with triple backticks
|
|
2. **PR Summary**: Output the generated summary in a markdown code block with triple backticks
|
|
|
|
This allows users to directly copy the content without manual formatting.
|
|
|
|
## Pull Request Summary Format
|
|
|
|
The summary should follow the format:
|
|
|
|
```markdown
|
|
### What this PR does / why we need it?
|
|
<!--
|
|
- Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
|
|
If possible, please consider writing useful notes for better and faster reviews in your PR.
|
|
|
|
- Please clarify why the changes are needed. For instance, the use case and bug description.
|
|
|
|
- Fixes #
|
|
-->
|
|
|
|
### Does this PR introduce _any_ user-facing change?
|
|
<!--
|
|
Note that it means *any* user-facing change including all aspects such as API, interface or other behavior changes.
|
|
Documentation-only updates are not considered user-facing changes.
|
|
-->
|
|
|
|
### How was this patch tested?
|
|
<!--
|
|
CI passed with new added/existing test.
|
|
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
|
|
If tests were not added, please describe why they were not added and/or why it was difficult to add.
|
|
-->
|
|
```
|
|
|
|
## Pull Request Title Format
|
|
|
|
The summary should also refresh the Pull Request Title to follow the format:
|
|
|
|
```txt
|
|
[Branch][Module][Action] Pull Request Title
|
|
```
|
|
|
|
- Branch: The branch name where the PR is based. If the base branch is main, this prefix can be omitted.
|
|
- Module: The module or component being changed. It includes but is not limited to the following:
|
|
- [Attention]
|
|
- [Ops]
|
|
- [Doc]
|
|
- [Test]
|
|
- [CI]
|
|
- [Benchmark]
|
|
- Action: The action being performed. It includes but is not limited to the following:
|
|
- [BugFix]
|
|
- [Feature]
|
|
- [Misc]
|
|
|
|
## Example Output Format
|
|
|
|
When providing a PR review, format your response like this:
|
|
|
|
**Suggested PR Title:**
|
|
|
|
```markdown
|
|
[Branch][Module][Action] Your generated title here
|
|
```
|
|
|
|
**Suggested PR Summary:**
|
|
|
|
```markdown
|
|
### What this PR does / why we need it?
|
|
|
|
Your analysis of what the PR does and why it's needed.
|
|
|
|
Fixes #issue_number
|
|
|
|
### Does this PR introduce _any_ user-facing change?
|
|
|
|
Your assessment of user-facing changes.
|
|
|
|
### How was this patch tested?
|
|
|
|
Your description of testing approach.
|
|
```
|
|
|
|
And please print your review suggestion in markdown format no matter the pull request description is empty or not.
|