summaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE.md
diff options
context:
space:
mode:
authorScott Dodson <sdodson@redhat.com>2017-01-11 09:18:50 -0500
committerScott Dodson <sdodson@redhat.com>2017-01-11 09:27:19 -0500
commite5d55ae873728e69645c83e43fd963f0f76ec1d7 (patch)
treeb7168c77c3a7357afc57a871a9d35c6b88311778 /.github/ISSUE_TEMPLATE.md
parent847bfb97009848e92edb587d6d792841c47ae4f5 (diff)
downloadopenshift-e5d55ae873728e69645c83e43fd963f0f76ec1d7.tar.gz
openshift-e5d55ae873728e69645c83e43fd963f0f76ec1d7.tar.bz2
openshift-e5d55ae873728e69645c83e43fd963f0f76ec1d7.tar.xz
openshift-e5d55ae873728e69645c83e43fd963f0f76ec1d7.zip
improve issue template
Diffstat (limited to '.github/ISSUE_TEMPLATE.md')
-rw-r--r--.github/ISSUE_TEMPLATE.md31
1 files changed, 22 insertions, 9 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index 627fa13eb..326e75c7e 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,21 +1,34 @@
-[provide a description of the issue]
+#### Description
+Please provide a brief description of your issue.
##### Version
-[if you're operating from a git clone provide the output of `git describe`]
-[if you're running from playbooks installed via RPM or atomic-openshift-utils `rpm -q atomic-openshift-utils openshift-ansible`]
-[Your version of ansible, `ansible --version`]
-
+If you're operating from a git clone provide the output of `git describe`. If
+you're running from playbooks installed via RPM or atomic-openshift-utils `rpm
+-q atomic-openshift-utils openshift-ansible`. Please also provide your version
+of ansible, `ansible --version`. Please the output between the code block below.
+```
+Please place output here
+```
##### Steps To Reproduce
1. [step 1]
2. [step 2]
+
##### Current Result
+```
+Example command and output or error messages
+```
##### Expected Result
+```
+Example command and output or error messages
+```
##### Additional Information
-[The exact command you ran]
-[Your operating system and version, ie: RHEL 7.2, Fedora 23]
-[Your inventory file]
-[visit https://docs.openshift.org/latest/welcome/index.html]
+```
+Your operating system and version, ie: RHEL 7.2, Fedora 23]
+Your inventory file
+Sample code, etc
+code, etc
+```