diff options
author | Sebastian Büttner <sebastian.buettner@softwareag.com> | 2021-04-07 16:24:57 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-04-07 16:24:57 +0200 |
commit | d785afa29d79350e05112de8be48a9df29f7be6a (patch) | |
tree | c9fcb539d618fa16971b40bb310c6db39b141f82 /.github | |
parent | 0ffa1ce1a44ff39a0ddc89e5d379cd260a6059a7 (diff) |
adding pull_request_template (#144)
* adding pull_request_template
Diffstat (limited to '.github')
-rw-r--r-- | .github/pull_request_template.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..6140791a --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,31 @@ +## 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 `thin-edge.io`? +_Put an `x` in the boxes that apply_ + +- [ ] Bugfix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Documentation Update (if none of the other choices apply) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) + +## Paste Link to the issue +<br/> + +## 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](https://github.com/thin-edge/thin-edge.io/blob/main/CONTRIBUTING.md) doc +- [ ] I have signed the [CLA](https://github.com/thin-edge/thin-edge.io/blob/main/CONTRIBUTOR-LICENSE-AGREEMENT.md) (in all commits with git commit -s) +- [ ] I ran `cargo fmt` as mentioned in [CODING_GUIDELINES](https://github.com/thin-edge/thin-edge.io/blob/main/CODING_GUIDELINES.md) +- [ ] I used `cargo clippy` as mentioned in [CODING_GUIDELINES](https://github.com/thin-edge/thin-edge.io/blob/main/CODING_GUIDELINES.md) +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] I have added necessary documentation (if appropriate) + +## 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... |