From 0b798800fc684df93b7b1c91aafe6ae7be50d719 Mon Sep 17 00:00:00 2001 From: Devin Ercolano Date: Fri, 20 Sep 2019 18:36:45 -0700 Subject: [PATCH] (chore) - Add pull request template for the project. --- .github/PULL_REQUEST_TEMPLATE.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 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 0000000000..42bbb1fba8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ + + +#Checklist +- [] For PRs that fix an issue, reviewers should try reproduce the issue and verify that the pull request actually fixes it. Authors can help with this by including a unit test that fails without (and passes with) the change. + +- [] For PRs adding new features, reviewers should attempt to use the feature and comment on how it feels to use it. Example: if a PR adds a new command line flag, use the program with the flag and comment on whether the flag feels useful. + +- [] We expect appropriate unit test coverage. Reviewers should verify that new code is covered by unit tests. + +- []Code submitted must pass all unit tests and static analysis (“lint”) checks. We use Travis CI to test code on Linux, macOS and AppVeyor to test code on Microsoft Windows. + +- [] For failing CI builds, the issue may not be related to the PR itself. Such failures are usually related to flakey tests. These failures can be ignored (authors don’t need to fix unrelated issues), but please file a GH issue so the test gets fixed eventually. + +# Reference/Link to the issue solved with this PR (if any) + +# Description of the problem + + +# Description of the solution +