f62a71e9de3a98438e7d38040f145fe77dfb48de

Author
Marc Cornellà <marc.cornella@live.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

meta: update issue templates

Diff

  1diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
  2index 2ac8c376935c7bb5944c89a29cf65855db24bf79..ff55f36be22e94707b5d924df9e8f3ea5674bd14 100644
  3--- a/.github/ISSUE_TEMPLATE/bug_report.md
  4+++ b/.github/ISSUE_TEMPLATE/bug_report.md
  5@@ -1,31 +1,39 @@
  6 ---
  7 name: Bug report
  8 about: Create a report to help us improve
  9-title: ''
 10 labels: 'Type: bug'
 11-assignees: ''
 12 
 13 ---
 14 
 15+<!--
 16+Fill this out before posting. You can delete irrelevant sections, but
 17+an issue where no sections have been filled will be deleted without comment.
 18+-->
 19+
 20 **Describe the bug**
 21-A clear and concise description of what the bug is.
 22+<!-- A clear and concise description of what the bug is. -->
 23 
 24 **To Reproduce**
 25+<!--
 26 Steps to reproduce the behavior:
 27 1. Enable plugin '...'
 28 2. Run command '...', _or_ try to complete command '...', _etc._
 29 3. See error
 30+-->
 31 
 32 **Expected behavior**
 33-A clear and concise description of what you expected to happen.
 34+<!-- A clear and concise description of what you expected to happen. -->
 35 
 36 **Screenshots or recordings**
 37-If applicable, add screenshots or record an [asciinema session](https://asciinema.org/) to help explain your problem.
 38+<!--
 39+If applicable, add screenshots or record an asciinema session (https://asciinema.org/)
 40+to help explain your problem.
 41+-->
 42 
 43-**Desktop (please complete the following information):**
 44+**System:**
 45  - OS: [e.g. macOS]
 46  - Zsh version [e.g. 5.6]
 47  - Terminal emulator [e.g. iTerm2]
 48 
 49 **Additional context**
 50-Add any other context about the problem here.
 51+<!-- Add any other context about the problem here. -->
 52diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
 53index daabf79400f5cad75cad9a23afa622dd44a7a534..3243e0b0a23a60d13b175ed68343ca19281614c2 100644
 54--- a/.github/ISSUE_TEMPLATE/feature_request.md
 55+++ b/.github/ISSUE_TEMPLATE/feature_request.md
 56@@ -1,23 +1,26 @@
 57 ---
 58 name: Feature request
 59 about: Suggest an idea for Oh My Zsh
 60-title: ''
 61 labels: 'Type: feature request'
 62-assignees: ''
 63 
 64 ---
 65 
 66+<!--
 67+Fill this out before posting. You can delete irrelevant sections, but
 68+an issue where no sections have been filled will be deleted without comment.
 69+-->
 70+
 71 **Is your feature request related to a particular plugin or theme? If so, specify it.**
 72-The name of the plugin or theme you'd like us to improve.
 73+<!-- The name of the plugin or theme you'd like us to improve. -->
 74 
 75 **Is your feature request related to a problem? Please describe.**
 76-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 77+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
 78 
 79 **Describe the solution you'd like**
 80-A clear and concise description of what you want to happen.
 81+<!-- A clear and concise description of what you want to happen. -->
 82 
 83 **Describe alternatives you've considered**
 84-A clear and concise description of any alternative solutions or features you've considered.
 85+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
 86 
 87 **Additional context**
 88-Add any other context or screenshots about the feature request here.
 89+<!-- Add any other context or screenshots about the feature request here. -->
 90diff --git a/.github/ISSUE_TEMPLATE/support.md b/.github/ISSUE_TEMPLATE/support.md
 91index 10b614b8ff65d5a84d70cabeb3fd7540fd7551fc..3c69a7d5ec2641bd9e2c98c88384382b12bdd9d4 100644
 92--- a/.github/ISSUE_TEMPLATE/support.md
 93+++ b/.github/ISSUE_TEMPLATE/support.md
 94@@ -1,13 +1,12 @@
 95 ---
 96 name: Support
 97 about: Request support for any problem you're having with Oh My Zsh
 98-title: ''
 99 labels: 'Type: support'
100-assignees: ''
101 
102 ---
103 
104 <!--
105-1. Try to make sure the issue is due to Oh My Zsh
106-2. Include as much information as possible
107+1. Look for similar issues already posted (including closed ones)
108+2. Include as much relevant information as possible
109+3. Try to make sure the issue is due to Oh My Zsh
110 -->