Add keyword hint | Collapse "PR Checklist" and "PR Type"
## Changes 1. Add hint on adding "Closes", "Fixes", etc. keywords to directly update the Issue state when the PR gets merged 2. Collapse "PR Checklist" and "PR Type". - With the assumption that these 2 items are mainly reminders for contributors, and that reviewers will typically only look at it one time, we collapse these sections to reduce clutter in the PR description.
This commit is contained in:
parent
dbaa702888
commit
cf905d25d5
1 changed files with 28 additions and 14 deletions
42
.github/PULL_REQUEST_TEMPLATE.md
vendored
42
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -1,15 +1,24 @@
|
||||||
## PR Checklist
|
## Fixes
|
||||||
|
|
||||||
<!-- For the checkbox formatting to work properly, make sure there are no spaces on either side of the "x" -->
|
Issue Number:
|
||||||
|
|
||||||
Please check all that apply to this PR using "x":
|
<!-- Tip:
|
||||||
|
- Add keywords to directly close the Issue when the PR is merged.
|
||||||
|
- Skip the keyword if the Issue contains multiple items.
|
||||||
|
- https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
|
||||||
|
-->
|
||||||
|
|
||||||
- [ ] I have checked that this PR is not a duplicate of an existing PR (open, closed or merged)
|
## What is the current behavior?
|
||||||
- [ ] I added a line describing my change to CHANGELOG.md
|
|
||||||
- [ ] I have checked that this PR does not introduce a breaking change
|
|
||||||
- [ ] This PR introduces breaking changes and I have provided a detailed explanation below
|
|
||||||
|
|
||||||
## PR Type
|
## What is the new behavior?
|
||||||
|
|
||||||
|
## Other information
|
||||||
|
|
||||||
|
<!-- If this PR contains a breaking change, please describe the impact and solution strategy for existing applications below. -->
|
||||||
|
|
||||||
|
## PR Type & Checklist
|
||||||
|
|
||||||
|
<details><summary>PR Type...</summary>
|
||||||
|
|
||||||
What kind of change does this PR introduce?
|
What kind of change does this PR introduce?
|
||||||
|
|
||||||
|
@ -20,14 +29,19 @@ What kind of change does this PR introduce?
|
||||||
- [ ] Documentation changes
|
- [ ] Documentation changes
|
||||||
- [ ] Other - Please describe:
|
- [ ] Other - Please describe:
|
||||||
|
|
||||||
## Fixes
|
</details>
|
||||||
|
|
||||||
Issue Number:
|
<!---------------------------------------------------------------------------->
|
||||||
|
|
||||||
## What is the current behavior?
|
<details><summary>PR Checklist...</summary>
|
||||||
|
|
||||||
## What is the new behavior?
|
<!-- For the checkbox formatting to work properly, make sure there are no spaces on either side of the "x" -->
|
||||||
|
|
||||||
## Other information
|
Please check all that apply to this PR using "x":
|
||||||
|
|
||||||
<!-- If this PR contains a breaking change, please describe the impact and solution strategy for existing applications below. -->
|
- [ ] I have checked that this PR is not a duplicate of an existing PR (open, closed or merged)
|
||||||
|
- [ ] I added a line describing my change to CHANGELOG.md
|
||||||
|
- [ ] I have checked that this PR does not introduce a breaking change
|
||||||
|
- [ ] This PR introduces breaking changes and I have provided a detailed explanation below
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
Loading…
Reference in a new issue