Skip to content

Commit e6e0f05

Browse files
committed
Update run-check.py to match PR template, add comments
1 parent 38f291c commit e6e0f05

File tree

3 files changed

+11
-0
lines changed

3 files changed

+11
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
<!---
2+
A technical comment, you are free to remove or leave it as it is when PR is created
3+
The following categories are used in the next scripts, update them accordingly
4+
utils/changelog/changelog.py
5+
tests/ci/run_check.py
6+
-->
17
### Changelog category (leave one):
28
- New Feature
39
- Improvement

tests/ci/run_check.py

+3
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,14 @@
2525
DO_NOT_TEST_LABEL = "do not test"
2626
SUBMODULE_CHANGED_LABEL = "submodule changed"
2727

28+
# They are used in .github/PULL_REQUEST_TEMPLATE.md, keep comments there
29+
# updated accordingly
2830
LABELS = {
2931
"pr-backward-incompatible": ["Backward Incompatible Change"],
3032
"pr-bugfix": [
3133
"Bug Fix",
3234
"Bug Fix (user-visible misbehaviour in official stable or prestable release)",
35+
"Bug Fix (user-visible misbehavior in official stable or prestable release)",
3336
],
3437
"pr-build": [
3538
"Build/Testing/Packaging Improvement",

utils/changelog/changelog.py

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919

2020
# This array gives the preferred category order, and is also used to
2121
# normalize category names.
22+
# Categories are used in .github/PULL_REQUEST_TEMPLATE.md, keep comments there
23+
# updated accordingly
2224
categories_preferred_order = (
2325
"Backward Incompatible Change",
2426
"New Feature",

0 commit comments

Comments
 (0)