From efe9e663b70833b27377bea29fcdfe2ec1c1b27a Mon Sep 17 00:00:00 2001 From: Jan Schulz Date: Thu, 18 Aug 2016 10:05:28 +0200 Subject: [PATCH] Requirement for a proper problem description in PR A lot of time I can't find out why a change in a commit was made because it either has no proper commit message or the commit message just says what was changed, but not why. Add text to the PR template to require such a problem description, so that one can comprehend why a change was made even years later. --- .github/PULL_REQUEST_TEMPLATE.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 918d427ee4f4c..9bbf82b9d3d41 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,5 @@ + [Add description of the problem and **why** this change is needed (what is the problem, how does this change fix that problem). This text ends up in the commit of the change and should help comprehend why a change was made, even years later.] + - [ ] closes #xxxx - [ ] tests added / passed - [ ] passes ``git diff upstream/master | flake8 --diff``