Skip to content

Commit

Permalink
chore(PULL_REQUEST_TEMPLATE): improve format and content
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-ciniawsky committed Aug 8, 2018
1 parent bdcbef0 commit 319d1f7
Showing 1 changed file with 36 additions and 23 deletions.
59 changes: 36 additions & 23 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -1,50 +1,63 @@
> ℹ️ 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.
### Notable Changes

### `Type`
---
<!-- ✏️ 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 -->

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

> _Put an `x` in the boxes that apply_
<!-- ⚠️ 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 -->

<!-- 👉 Replace the example with your changes or otherwise delete the code block in case no additional information is needed -->

```bash
# Commit Message Body
#
# Example
BREAKING CHANGE: requires `node >= v8.0.0`
BREAKING CHANGE: `options.x` requires to be a `{Function}` now
```

### Type

> ℹ️ What type of changes does your code introduce?
<!-- 👉 Put an `x` in the boxes that apply and delete all others -->

- [ ] CI
- [ ] Fix
- [ ] Perf
- [ ] Docs
- [ ] Test
- [ ] Style
- [ ] Build
- [ ] Chore
- [ ] Feature
- [ ] Refactor

### `SemVer`
---
### Issues

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

- [ ] Bug (:label: Patch)
- [ ] Feature (:label: Minor)
- [ ] Breaking Change (:label: Major)
- Fixes `#1`

### `Issues`
---
### SemVer

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

- Fixes `#1`
- [ ] Fix (:label: Patch)
- [ ] Feature (:label: Minor)
- [ ] Breaking Change (:label: Major)

### `Checklist`
---
### Checklist

> ℹ️ 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.
> _Put an `x` in the boxes that apply._
<!-- 👉 Put an `x` in the boxes that apply and delete all others -->

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

0 comments on commit 319d1f7

Please sign in to comment.