Skip to content

Commit de8f428

Browse files
authored
docs: Simplify pull request template (#1100)
The existing template is very verbose with many of the lines not being applicable to any given PR. This also makes the PR description poorly suitable for a commit description. By having a cleaner PR description that is commit message friendly, whoever merges the PR can more easily create a meaningful commit message. It also allows other maintainer's to clean up the description prior to it being merged.
1 parent 7d82f06 commit de8f428

File tree

1 file changed

+11
-44
lines changed

1 file changed

+11
-44
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,11 @@
1-
## PR Checklist
2-
3-
Please check if your PR fulfills the following requirements:
4-
5-
- [ ] Tests for the changes have been added (for bug fixes / features)
6-
- [ ] Docs have been added / updated (for bug fixes / features)
7-
8-
9-
## PR Type
10-
11-
What kind of change does this PR introduce?
12-
13-
<!-- Please check the one that applies to this PR using "x". -->
14-
15-
- [ ] Bugfix
16-
- [ ] Feature (please, look at the "Scope of the project" section in the README.md file)
17-
- [ ] Code style update (formatting, local variables)
18-
- [ ] Refactoring (no functional changes, no api changes)
19-
- [ ] Build related changes
20-
- [ ] CI related changes
21-
- [ ] Documentation content changes
22-
- [ ] Other... Please describe:
23-
24-
25-
## What is the current behavior?
26-
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
27-
28-
Issue Number: N/A
29-
30-
31-
## What is the new behavior?
32-
33-
34-
## Does this PR introduce a breaking change?
35-
36-
- [ ] Yes
37-
- [ ] No
38-
39-
40-
<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
41-
42-
43-
## Other information
44-
1+
PR Instructions/requirements
2+
* Title uses `type: description` format. See CONTRIBUTING.md for types.
3+
* Common types are: build, docs, feat, fix, refactor, revert, test
4+
* Breaking changes include "!" after the type and a "BREAKING CHANGES:"
5+
section at the bottom.
6+
* Body text describes:
7+
* Why this change is being made, briefly.
8+
* Before and after behavior, as applicable
9+
* References issue number, as applicable
10+
* Update docs and tests, as applicable
11+
* Delete these instructions prior to sending the PR

0 commit comments

Comments
 (0)