summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorDag Wieers <dag@wieers.com>2016-03-23 13:49:20 +0100
committerDag Wieers <dag@wieers.com>2016-03-23 13:49:20 +0100
commit2e9fc918442bcc0eb5161e1e8c179348793a1818 (patch)
treeb618f39134183046be28a0aa52cfcdb00a353bc3 /.github
parent72e111ecca607c98bea1f20966283870e9304941 (diff)
downloadansible-2e9fc918442bcc0eb5161e1e8c179348793a1818.tar.gz
Various improvements to issue/pull-request templates
- Instruct to verify if an issue/request already exists - Use uppercase for titles (easier to parse as titles) - Remove empty lines where it makes sense (instructions) - Ensure that commit-message appears directly under summary (pull-requests)
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE.md35
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md19
2 files changed, 22 insertions, 32 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index 56907da419..f5c4e11789 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,55 +1,50 @@
-##### Issue Type:
+<!--- Verify first that your issue/request is not already reported in GitHub -->
-<!--- Please pick one and delete the rest: -->
+##### ISSUE TYPE
+<!--- Pick one below and delete the rest: -->
- Bug Report
- Feature Idea
- Documentation Report
-##### Ansible Version:
+##### ANSIBLE VERSION
```
-<!--- Paste verbatim output from “ansible --version” here -->
+<!--- Paste verbatim output from “ansible --version” between quotes -->
```
-##### Ansible Configuration:
-
+##### CONFIGURATION
<!---
-Please mention any settings you have changed/added/removed in ansible.cfg
+Mention any settings you have changed/added/removed in ansible.cfg
(or using the ANSIBLE_* environment variables).
-->
-##### Environment:
-
+##### OS / ENVIRONMENT
<!---
-Please mention the OS you are running Ansible from, and the OS you are
+Mention the OS you are running Ansible from, and the OS you are
managing, or say “N/A” for anything that is not platform-specific.
-->
-##### Summary:
-
+##### SUMMARY
<!--- Please explain the problem briefly -->
-##### Steps To Reproduce:
-
+##### STEPS TO REPRODUCE
<!---
For bugs, please show exactly how to reproduce the problem. For new
features, show how the feature would be used.
-->
```
-<!--- Paste example playbooks or commands here -->
+<!--- Paste example playbooks or commands between quotes -->
```
<!--- You can also paste gist.github.com links for larger files -->
-##### Expected Results:
-
+##### EXPECTED RESULTS
<!--- What did you expect to happen when running the steps above? -->
-##### Actual Results:
-
+##### ACTUAL RESULTS
<!--- What actually happened? If possible run with high verbosity (-vvvv) -->
```
-<!--- Paste verbatim command output here -->
+<!--- Paste verbatim command output between quotes -->
```
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 3c348908ed..b9a1918530 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,20 +1,17 @@
-##### Issue Type:
-
-<!--- Please pick one and delete the rest: -->
+##### ISSUE TYPE
+<!--- Pick one below and delete the rest: -->
- Feature Pull Request
- New Module Pull Request
- Bugfix Pull Request
- Docs Pull Request
-##### Ansible Version:
-
+##### ANSIBLE VERSION
```
-<!--- Paste verbatim output from “ansible --version” here -->
+<!--- Paste verbatim output from “ansible --version” between quotes -->
```
-##### Summary:
-
-<!--- Please describe the change and the reason for it -->
+##### SUMMARY
+<!--- Describe the change, including rationale and design decisions -->
<!---
If you are fixing an existing issue, please include "Fixes #nnn" in your
@@ -22,8 +19,6 @@ commit message and your description; but you should still explain what
the change does.
-->
-##### Example output:
-
```
-<!-- Paste verbatim command output here if necessary -->
+<!-- Paste verbatim command output here, e.g. before and after your change -->
```