From efc071c712878cc5c1d2ad1e3cc55c49486a1d82 Mon Sep 17 00:00:00 2001 From: TP Honey Date: Tue, 20 Jul 2021 16:31:45 +0100 Subject: [PATCH] Update pull_request_template.md --- .github/pull_request_template.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e69de29b..00ec310d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -0,0 +1,26 @@ +## Commit Checklist + +Thank you for creating a pull request !! to help us review / merge this can you make sure that your PR adheres as much as possible to the following. + +### The Basics + +- my commit is a single logical unit of work, only use multiple commits if doing different tasks +- my commit does not include commented out code or unneeded files +- rebase of main branch + +### The Content + +- my commit includes tests for the bug I fixed or feature I added +- my commit includes appropriate documentation changes if it is introducing a new feature or changing existing functionality +- my code passes existing test suites + +### The Commit Message + +- short description is meaningful +- uses the imperative, present tense: "change", not "changed" or "changes" +- includes motivation for the change, and contrasts its implementation with the previous behavior + +### The Pull Request + +- why, what is the reason for this change +- example usage of the failure for a bug, or configuration and expected output for a feature