diff options
| author | Bundlerbot <bot@bundler.io> | 2020-01-20 07:05:37 +0000 |
|---|---|---|
| committer | Bundlerbot <bot@bundler.io> | 2020-01-20 07:05:37 +0000 |
| commit | 6d983dccbe1e69bfd893a931d4d5b47000b2805e (patch) | |
| tree | 115d19e8d4ca6178028ba9ade24c89aa16bec9e8 | |
| parent | 94288385498a69e679b576affae393578131e2a3 (diff) | |
| parent | 9cdd01eea0ef6f68fdfcf582e7d05e0f684ff60c (diff) | |
| download | bundler-6d983dccbe1e69bfd893a931d4d5b47000b2805e.tar.gz | |
Merge #7574
7574: Improve PR template r=indirect a=deivid-rodriguez
### What was the end-user problem that led to this PR?
The problem was that the current PR template sometimes asks too many questions, and the answers are a bit artificial.
### What was your diagnosis of the problem?
My diagnosis was that experience tell me that some questions are too much, and a bit artificial to answer for many PRs.
### What is your fix for the problem, implemented in this PR?
My fix is to still let contributors know what kind of information we find valuable, but don't force all questions to be answered.
Co-authored-by: David RodrÃguez <deivid.rodriguez@riseup.net>
| -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 --> |