diff options
author | Matthew Ahrens <[email protected]> | 2018-07-23 22:08:18 -0700 |
---|---|---|
committer | Brian Behlendorf <[email protected]> | 2018-07-23 22:08:18 -0700 |
commit | fda0f162171585891d7865bc7bd5e49255b4564b (patch) | |
tree | 6d8c3bdd98c9798239ca05b5f45cb9199ea9b1ad /.github/PULL_REQUEST_TEMPLATE.md | |
parent | d441e85dd754ecc15659322b4d36796cbd3838de (diff) |
PR's should provide motivation & context first
It's often necessary to understand why a change is made, before
understanding the exact changes that are made. Context provides
background, which by definition is necessary to understand prior to the
substance of the Pull Request.
Change the PR template to request "Motivation and Context" first, before
"Description".
Reviewed-by: Giuseppe Di Natale <[email protected]>
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Matthew Ahrens <[email protected]>
Closes #7737
Diffstat (limited to '.github/PULL_REQUEST_TEMPLATE.md')
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 63a3e0f27..826da9393 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,13 +5,13 @@ Documentation on ZFS Buildbot options can be found at https://github.com/zfsonlinux/zfs/wiki/Buildbot-Options --> -### Description -<!--- Describe your changes in detail --> - ### Motivation and Context <!--- Why is this change required? What problem does it solve? --> <!--- If it fixes an open issue, please link to the issue here. --> +### Description +<!--- Describe your changes in detail --> + ### How Has This Been Tested? <!--- Please describe in detail how you tested your changes. --> <!--- Include details of your testing environment, and the tests you ran to --> |