Skip to content

Commit 4e8614e

Browse files
Move checklist in PR template (#22852)
Signed-off-by: Luka Govedic <[email protected]>
1 parent c6cd5ca commit 4e8614e

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -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.
93

104
## Purpose
115

@@ -15,4 +9,14 @@ PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS ABOVE HAVE B
159

1610
## (Optional) Documentation Update
1711

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+
1822
**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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ NEW=/tmp/new_pr_body.txt
1515
gh pr view --json body --template "{{.body}}" "${PR_NUMBER}" > "${OLD}"
1616
cp "${OLD}" "${NEW}"
1717

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}"
2020

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}"
2323

2424
# Remove all lines after and including "**BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE**"
2525
sed -i '/\*\*BEFORE SUBMITTING, PLEASE READ.*\*\*/,$d' "${NEW}"

0 commit comments

Comments
 (0)