From 3439836cd593eb2862ead540746ecef543a9c401 Mon Sep 17 00:00:00 2001 From: Olaoluwa Osuntokun Date: Mon, 17 Dec 2018 19:43:50 -0800 Subject: [PATCH] github: add PR contribution checklist --- .github/pull_request_template.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..2ca61829 --- /dev/null +++ b/.github/pull_request_template.md @@ -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