diff options
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 67dfa5b2c6..a721e8bf0d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,19 @@ +<!-- Thanks so much for the contribution! -To make reviewing this PR a bit easier, please fill out answers to the following questions. -### What was the end-user problem that led to this PR? +If you're updating documentation, make sure you run `bin/rake man:build` and +squash the result into your changes, so that all documentation formats are +updated. -The problem was... +To make reviewing this PR a bit easier, please fill out answers to the following questions. +--> -### What was your diagnosis of the problem? +### What was the end-user or developer problem that led to this PR? -My diagnosis was... +<!-- Write a clear and complete description of the problem --> ### What is your fix for the problem, implemented in this PR? -My fix... - -### Why did you choose this fix out of the possible options? - -I chose this fix because... +<!-- Explain the fix being implemented. Include any diagnosis you run to +determine the cause of the issue and your conclusions. If you considered other +alternatives, explain why you end up choosing the current implementation --> |