chore(pull request template): update the template and make in work @ github.

This commit is contained in:
xobotyi 2019-11-01 22:55:13 +03:00
parent 1dc21f3e61
commit e42f882abf
2 changed files with 33 additions and 29 deletions

33
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,33 @@
# Description
<!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. -->
## Use case
<!-- What is the final use case? Describe it with words, code or even sandboxes (4ex: [codesandbox.io](https://codesandbox.io)) -->
## Type of change
<!-- Please delete options that are not relevant. -->
- [x] _Bug fix_ (non-breaking change which fixes an issue)
- [x] _New feature_ (non-breaking change which adds functionality)
- [x] **_Breaking change_** (fix or feature that would cause existing functionality to not work as before)
# Checklist
<!-- Check all the items your PR meets. In general - only coverage item is allowed not to be checked. -->
- [ ] Read the [Contributing Guide](https://github.com/streamich/react-use/blob/master/CONTRIBUTING.md)
- [ ] Perform a code self-review
- [ ] Comment the code, particularly in hard-to-understand areas
- [ ] Update/add the documentation
- [ ] Create the story
- [ ] Write tests
- [ ] Ensure the test suite passes (`yarn test`)
- [ ] Provide 100% tests coverage
- [ ] Make sure code lints (`yarn lint`). Fix it with `yarn lint:fix` in case of problems.
- [ ] Make sure types are fine (`yarn lint:types`).
<!-- If you can't check all the checkboxes - create a Draft PR and get back to it when you will be able to put some marks in list. -->

View File

@ -1,29 +0,0 @@
---
name: Feature PR
about: Made something cool, what in your opinion lacks in this lib?
title: feat:
labels: enhancement
assignees: ''
---
# Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List dependencies that are required for this change if it has any.
<!-- Please delete options that are not relevant. -->
- [ ] Breaking change (this feature would cause existing functionality to not work as before)
# Checklist
- [ ] Make sure accordance to [Contributing Guide](https://github.com/streamich/react-use/blob/master/CONTRIBUTING.md)
- [ ] Perform a self-review of my own code
- [ ] Comment my code, particularly in hard-to-understand areas
- [ ] Write documentation
- [ ] Write tests
- [ ] Ensure test suite passes (`yarn test`)
- [ ] Achieve 100% LOC tests coverage
- [ ] Create story
- [ ] Update the `README.md`
- [ ] Make sure code lints (`yarn lint`)
- [ ] Make sure types are fine (`yarn lint:types`)