File tree Expand file tree Collapse file tree 2 files changed +16
-12
lines changed Expand file tree Collapse file tree 2 files changed +16
-12
lines changed Original file line number Diff line number Diff line change 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.
9
3
10
4
## Purpose
11
5
@@ -15,4 +9,14 @@ PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS ABOVE HAVE B
15
9
16
10
## (Optional) Documentation Update
17
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
+
18
22
** BEFORE SUBMITTING, PLEASE READ < https://docs.vllm.ai/en/latest/contributing > ** (anything written below this line will be removed by GitHub Actions)
Original file line number Diff line number Diff line change @@ -15,11 +15,11 @@ NEW=/tmp/new_pr_body.txt
15
15
gh pr view --json body --template " {{.body}}" " ${PR_NUMBER} " > " ${OLD} "
16
16
cp " ${OLD} " " ${NEW} "
17
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
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
23
24
24
# Remove all lines after and including "**BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE**"
25
25
sed -i ' /\*\*BEFORE SUBMITTING, PLEASE READ.*\*\*/,$d' " ${NEW} "
You can’t perform that action at this time.
0 commit comments