github: add PR contribution checklist

This commit is contained in:
Olaoluwa Osuntokun 2018-12-17 19:43:50 -08:00
parent 152fc8b1f1
commit 3439836cd5
No known key found for this signature in database
GPG Key ID: CE58F7F8E20FD9A2

19
.github/pull_request_template.md vendored Normal file

@ -0,0 +1,19 @@
#### Pull Request Checklist
- [ ] All changes are Go version 1.11 compliant
- [ ] The code being submitted is commented according to the
[Code Documentation and Commenting](#CodeDocumentation) section
- [ ] For new code: Code is accompanied by tests which exercise both
the positive and negative (error paths) conditions (if applicable)
- [ ] For bug fixes: Code is accompanied by new tests which trigger
the bug being fixed to prevent regressions
- [ ] Any new logging statements use an appropriate subsystem and
logging level
- [ ] Code has been formatted with `go fmt`
- [ ] For code and documentation: lines are wrapped at 80 characters
(the tab character should be counted as 8 characters, not 4, as some IDEs do
per default)
- [ ] Running `make check` does not fail any tests
- [ ] Running `go vet` does not report any issues
- [ ] Running `make lint` does not report any **new** issues that did not
already exist