Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
OpenDAS
vllm_cscc
Commits
4e8614e8
Unverified
Commit
4e8614e8
authored
Aug 13, 2025
by
Luka Govedič
Committed by
GitHub
Aug 13, 2025
Browse files
Move checklist in PR template (#22852)
Signed-off-by:
Luka Govedic
<
lgovedic@redhat.com
>
parent
c6cd5ca3
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
16 additions
and
12 deletions
+16
-12
.github/PULL_REQUEST_TEMPLATE.md
.github/PULL_REQUEST_TEMPLATE.md
+12
-8
.github/scripts/cleanup_pr_body.sh
.github/scripts/cleanup_pr_body.sh
+4
-4
No files found.
.github/PULL_REQUEST_TEMPLATE.md
View file @
4e8614e8
# Essential Elements of an Effective PR Description Checklist
-
[ ] The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
-
[ ] The test plan, such as providing test command.
-
[ ] The test results, such as pasting the results comparison before and after, or e2e results
-
[ ] (Optional) The necessary documentation update, such as updating
`supported_models.md`
and
`examples`
for a new model.
PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS ABOVE HAVE BEEN CONSIDERED.
<!-- markdownlint-disable -->
PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS (AT THE BOTTOM) HAVE BEEN CONSIDERED.
## Purpose
...
...
@@ -15,4 +9,14 @@ PLEASE FILL IN THE PR DESCRIPTION HERE ENSURING ALL CHECKLIST ITEMS ABOVE HAVE B
## (Optional) Documentation Update
---
<details>
<summary>
Essential Elements of an Effective PR Description Checklist
</summary>
-
[ ] The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
-
[ ] The test plan, such as providing test command.
-
[ ] The test results, such as pasting the results comparison before and after, or e2e results
-
[ ] (Optional) The necessary documentation update, such as updating
`supported_models.md`
and
`examples`
for a new model.
</details>
**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
View file @
4e8614e8
...
...
@@ -15,11 +15,11 @@ NEW=/tmp/new_pr_body.txt
gh
pr
view
--json
body
--template
"{{.body}}"
"
${
PR_NUMBER
}
"
>
"
${
OLD
}
"
cp
"
${
OLD
}
"
"
${
NEW
}
"
# Remove
"FIX #xxxx
(
*
li
nk existing issues this PR will resolve*)"
sed
-i
'/
FIX #xxxx.*
$/d'
"
${
NEW
}
"
# Remove
markdown comments
(li
ke the <!-- markdownlint-disable --> at the start)
sed
-i
'/
<!--.*-->
$/d'
"
${
NEW
}
"
# Remove "FILL IN THE PR DESCRIPTION HERE"
sed
-i
'/FILL IN THE PR DESCRIPTION HERE/d'
"
${
NEW
}
"
# Remove "
PLEASE
FILL IN THE PR DESCRIPTION HERE
ENSURING ALL CHECKLIST ITEMS (AT THE BOTTOM) HAVE BEEN CONSIDERED.
"
sed
-i
'/
PLEASE
FILL IN THE PR DESCRIPTION HERE
.*$
/d'
"
${
NEW
}
"
# Remove all lines after and including "**BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE**"
sed
-i
'/\*\*BEFORE SUBMITTING, PLEASE READ.*\*\*/,$d'
"
${
NEW
}
"
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment