Merge pull request #48 from cjappl/pr_template

Adding a PR template
This commit is contained in:
Wenxuan 2019-11-07 11:16:36 +08:00 committed by GitHub
commit 1aa89aa659
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

36
.github/pull_request_template.md vendored Normal file
View file

@ -0,0 +1,36 @@
# Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context, such as the description of the bug you're trying to fix.
Fixes # (issue)
## Type of change
Please delete options that are not relevant.
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
## Shells this fix should effect:
- [ ] bash
- [ ] zsh
- [ ] fish
## Shells this fix has been tested in:
- [ ] bash
- [ ] zsh
- [ ] fish
**Test Configuration**:
* OS:
# Checklist:
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
@cjappl @wfxr