diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..6c4b11f --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ +# Pull Request Template + +## Description + +Please include a summary of the change or which issue is fixed. Also, include relevant motivation and context. +Remember, as mentioned in the [contribution guidelines](https://github.com/checkly/puppeteer-recorder/blob/master/CONTRIBUTING.md) that +PR's should be as atomic as possible 1 feature === 1 PR. 1 bugfix === 1 PR. + +## 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 + +## How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. + +## Checklist: + +- [ ] My code follows the style guidelines of this project. `npm run lint` passes with no errors. +- [ ] I have made corresponding changes to the documentation +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes. `npm run test` passes with no errors.