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 14, 05:30 UTC
Move checklist in PR template (#22852)
Signed-off-by: Luka Govedic <lgovedic@redhat.com>
Luka Govedič committed
Aug 13, 2025 at 17:38 UTC
4e8614e88bf621d11682b6f387c8640f6c9ad086
2 files changed
+16
-12
.github/PULL_REQUEST_TEMPLATE.md
+12
-8
@@ -1,11 +1,5 @@
1
-# Essential Elements of an Effective PR Description Checklist
2
-
3
-- [ ] The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
4
-- [ ] The test plan, such as providing test command.
5
-- [ ] The test results, such as pasting the results comparison before and after, or e2e results
6
-- [ ] (Optional) The necessary documentation update, such as updating `supported_models.md` and `examples` for a new model.
7
-
8
-PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS ABOVE HAVE BEEN CONSIDERED.
1
+<!-- markdownlint-disable -->
2
+PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS (AT THE BOTTOM) HAVE BEEN CONSIDERED.
3
4
## Purpose
5
@@ -15,4 +9,14 @@ PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS ABOVE HAVE B
9
10
## (Optional) Documentation Update
11
12
+---
13
+<details>
14
+<summary> Essential Elements of an Effective PR Description Checklist </summary>
15
+
16
+- [ ] The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
17
+- [ ] The test plan, such as providing test command.
18
+- [ ] The test results, such as pasting the results comparison before and after, or e2e results
19
+- [ ] (Optional) The necessary documentation update, such as updating `supported_models.md` and `examples` for a new model.
20
+</details>
21
+
22
**BEFORE SUBMITTING, PLEASE READ <https://docs.vllm.ai/en/latest/contributing>** (anything written below this line will be removed by GitHub Actions)
.github/scripts/cleanup_pr_body.sh
+4
-4
@@ -15,11 +15,11 @@ NEW=/tmp/new_pr_body.txt
15
gh pr view --json body --template "{{.body}}" "${PR_NUMBER}" > "${OLD}"
16
cp "${OLD}" "${NEW}"
17
18
-# Remove "FIX #xxxx (*link existing issues this PR will resolve*)"
19
-sed -i '/FIX #xxxx.*$/d' "${NEW}"
18
+# Remove markdown comments (like the <!-- markdownlint-disable --> at the start)
19
+sed -i '/<!--.*-->$/d' "${NEW}"
20
21
-# Remove "FILL IN THE PR DESCRIPTION HERE"
22
-sed -i '/FILL IN THE PR DESCRIPTION HERE/d' "${NEW}"
21
+# Remove "PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS (AT THE BOTTOM) HAVE BEEN CONSIDERED."
22
+sed -i '/PLEASE FILL IN THE PR DESCRIPTION HERE.*$/d' "${NEW}"
23
24
# Remove all lines after and including "**BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE**"
25
sed -i '/\*\*BEFORE SUBMITTING, PLEASE READ.*\*\*/,$d' "${NEW}"