Przeglądaj źródła

improve issue template

Scott Dodson 8 lat temu
rodzic
commit
e5d55ae873
1 zmienionych plików z 22 dodań i 9 usunięć
  1. 22 9
      .github/ISSUE_TEMPLATE.md

+ 22 - 9
.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
+```