]> granicus.if.org Git - zfs/commitdiff
PR's should provide motivation & context first
authorMatthew Ahrens <mahrens@delphix.com>
Tue, 24 Jul 2018 05:08:18 +0000 (22:08 -0700)
committerBrian Behlendorf <behlendorf1@llnl.gov>
Tue, 24 Jul 2018 05:08:18 +0000 (22:08 -0700)
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 <guss80@gmail.com>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Matthew Ahrens <mahrens@delphix.com>
Closes #7737

.github/PULL_REQUEST_TEMPLATE.md

index 63a3e0f2754c4131c7a777e89f1560be0c1439e6..826da9393cae25e20502861e16913ce9da8f1e05 100644 (file)
@@ -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 -->