summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKevin Kirsche <Kev.Kirsche+GitHub@gmail.com>2016-11-18 15:15:14 -0500
committerBrian Coca <bcoca@users.noreply.github.com>2016-11-18 15:31:17 -0500
commit514a2d40c179cc51d58972c02fe723d6b57d3b40 (patch)
tree2205170aeeb3e02d8fbba5918c9a8202046fe3c4
parent9724ed77defa17808d264ed339ec775def0ea419 (diff)
downloadansible-modules-core-514a2d40c179cc51d58972c02fe723d6b57d3b40.tar.gz
Update pull request template to provide context
This updates the pull request template to provide more context about why specific things may be needed. This helps to make it feel like it is being asked for to help the team rather than arbitrary questions that don't seem applicable, such as command output for a docs change.
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 5cfd0271..4bfadfb6 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -9,7 +9,11 @@
<!--- Name of the plugin/module/task -->
##### ANSIBLE VERSION
-<!--- Paste verbatim output from “ansible --version” between quotes below -->
+<!---
+Paste verbatim output from “ansible --version” between quotes below,
+this is to help the Ansible team determine if this is a version specific
+issue which is being fixed.
+-->
```
```
@@ -22,7 +26,11 @@ If you are fixing an existing issue, please include "Fixes #nnnn" in your commit
message and your description; but you should still explain what the change does.
-->
-<!--- Paste verbatim command output below, e.g. before and after your change -->
+<!---
+Please paste verbatim command output below, e.g. before and after your change.
+Even in the event of a Docs Pull Request, this allows the Ansible team to quickly
+verify that there were no accidental syntax mistakes.
+-->
```
```