diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..db0d4222 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,33 @@ +# Description + + + + +## Use case + + + + +## Type of change + + +- [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 + + + +- [ ] 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`). + + diff --git a/.github/PULL_REQUEST_TEMPLATE/feature_pr.md b/.github/PULL_REQUEST_TEMPLATE/feature_pr.md deleted file mode 100644 index 7d346d91..00000000 --- a/.github/PULL_REQUEST_TEMPLATE/feature_pr.md +++ /dev/null @@ -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. - - -- [ ] 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`)