Skip to content

Commit 319d1f7

Browse files
committedAug 8, 2018
chore(PULL_REQUEST_TEMPLATE): improve format and content
1 parent bdcbef0 commit 319d1f7

File tree

1 file changed

+36
-23
lines changed

1 file changed

+36
-23
lines changed
 

‎.github/PULL_REQUEST_TEMPLATE.md

+36-23
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,63 @@
1-
> ℹ️ Describe the big picture of your changes here to communicate to the maintainers
2-
why we should accept this pull request. If it fixes a bug or resolves a feature
3-
request, be sure to link to that issue.
1+
### Notable Changes
42

5-
### `Type`
6-
---
3+
<!-- ✏️ Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue(s) down below -->
74

8-
> ℹ️ What types of changes does your code introduce?
5+
#### `Commit Message Summary (CHANGELOG)`
96

10-
> _Put an `x` in the boxes that apply_
7+
<!-- ⚠️ All commits will be squashed into a single commit when merging the PR, so if there is any additional information needed to describe your changes (e.g BREAKING CHANGES), please list them here so the maintainers are able to include them as the commit message body of the final commit. I case your unsure what might be relevant don't hesitate to ask -->
118

9+
<!-- 👉 Replace the example with your changes or otherwise delete the code block in case no additional information is needed -->
10+
11+
```bash
12+
# Commit Message Body
13+
#
14+
# Example
15+
BREAKING CHANGE: requires `node >= v8.0.0`
16+
BREAKING CHANGE: `options.x` requires to be a `{Function}` now
17+
```
18+
19+
### Type
20+
21+
> ℹ️ What type of changes does your code introduce?
22+
23+
<!-- 👉 Put an `x` in the boxes that apply and delete all others -->
24+
25+
- [ ] CI
1226
- [ ] Fix
1327
- [ ] Perf
1428
- [ ] Docs
1529
- [ ] Test
30+
- [ ] Style
31+
- [ ] Build
1632
- [ ] Chore
1733
- [ ] Feature
1834
- [ ] Refactor
1935

20-
### `SemVer`
21-
---
36+
### Issues
2237

23-
> ℹ️ What changes to the current `semver` range does your PR introduce?
38+
> ℹ️ What issue(s) (if any) are closed by your PR?
2439
25-
> _Put an `x` in the boxes that apply_
40+
<!-- 👉 Replace `#1` with the issue number that applies and remove the ``` ` ``` (`#1` => #1) -->
2641

27-
- [ ] Bug (:label: Patch)
28-
- [ ] Feature (:label: Minor)
29-
- [ ] Breaking Change (:label: Major)
42+
- Fixes `#1`
3043

31-
### `Issues`
32-
---
44+
### SemVer
3345

34-
> ℹ️ What issue (if any) are closed by your PR?
46+
> ℹ️ What changes to the current `semver` range does your PR introduce?
3547
36-
> _Replace `#1` with the error number that applies_
48+
<!-- 👉 Put an `x` in the boxes that apply and delete all others -->
3749

38-
- Fixes `#1`
50+
- [ ] Fix (:label: Patch)
51+
- [ ] Feature (:label: Minor)
52+
- [ ] Breaking Change (:label: Major)
3953

40-
### `Checklist`
41-
---
54+
### Checklist
4255

4356
> ℹ️ You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. This is a reminder of what we are going to look for before merging your code.
4457
45-
> _Put an `x` in the boxes that apply._
58+
<!-- 👉 Put an `x` in the boxes that apply and delete all others -->
4659

4760
- [ ] Lint and unit tests pass with my changes
48-
- [ ] I have added tests that prove my fix is effective/works
61+
- [ ] I have added tests that prove my fix is effective/works (if needed)
4962
- [ ] I have added necessary documentation (if appropriate)
5063
- [ ] Any dependent changes are merged and published in downstream modules

0 commit comments

Comments
 (0)
Please sign in to comment.