diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..2d1c1dd --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,19 @@ +## The problem + +Briefly describe the issue you are experiencing (or the feature you want to see added). Tell us what you were trying to do and what happened instead. Remember, an issue is not the place to ask questions. + +Before you open an issue, please check if a similar issue already exists or has been closed before. + +### When reporting a bug, please be sure to include the following: +- [ ] A descriptive title +- [ ] An *isolated* way to reproduce the behavior (example: GitHub repository with code isolated to the issue that anyone can clone to observe the problem) +- [ ] What is the version you're using, and the platform(s) you're running it on +- [ ] What packages or other dependencies you're using +- [ ] The behavior you expect to see, and the actual behavior + +### When you open an issue for a feature request, please add as much detail as possible: +- [ ] A descriptive title +- [ ] A description of the problem you're trying to solve, including *why* you think this is a problem +- [ ] An overview of the suggested solution +- [ ] If the feature changes current behavior, reasons why your solution is better + diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..505853d --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,26 @@ +## Proposed changes + +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. + +## Types of changes + +What types of changes does your code introduce to dynamodb-localhost? +_Put an `x` in the boxes that apply_ + +- [ ] Bugfix (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) + +## Checklist + +_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._ + +- [ ] I have read the CONTRIBUTING.md doc +- [ ] Lint and unit tests pass locally with my changes +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] I have added necessary documentation (if appropriate) +- [ ] Any dependent changes have been merged and published in downstream modules + +## Further comments + +If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... \ No newline at end of file