A high-throughput and memory-efficient inference and serving engine for LLMs
Mirrored from https://github.com/tduncan-lum/Nvidia-Optimization-Stack---VLLM.git
Synced Nov 15, 07:15 UTC
[Doc] Improve the Pull Request template with key components (#19086)
Signed-off-by: Lu Fang <lufang@fb.com>
Lu Fang committed
Jun 3, 2025 at 23:44 UTC
d00dd65cd4dbc1ebbdbe2cd070ff694e9e9321a2
1 file changed
+11
-2
.github/PULL_REQUEST_TEMPLATE.md
+11
-2
@@ -1,6 +1,15 @@
1
-FILL IN THE PR DESCRIPTION HERE
1
+## Essential Elements of an Effective PR Description Checklist
2
+- [ ] The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
3
+- [ ] The test plan, such as providing test command.
4
+- [ ] The test results, such as pasting the results comparison before and after, or e2e results
5
3
-FIX #xxxx (*link existing issues this PR will resolve*)
6
+PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS ABOVE HAVE BEEN CONSIDERED.
7
+
8
+## Purpose
9
+
10
+## Test Plan
11
+
12
+## Test Result
13
14
<!--- pyml disable-next-line no-emphasis-as-heading -->
15
**BEFORE SUBMITTING, PLEASE READ <https://docs.vllm.ai/en/latest/contributing>** (anything written below this line will be removed by GitHub Actions)