summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-05-21 11:53:52 +0200
committerMarc Cornellà <marc.cornella@live.com>2019-05-21 11:53:52 +0200
commitf62a71e9de3a98438e7d38040f145fe77dfb48de (patch)
treeed16da8c2f9b5d6c37d179a604c31d9d02de9759 /.github
parent4ad4a81657d044de2839e988ff3338fa398e5d9b (diff)
downloadzsh-f62a71e9de3a98438e7d38040f145fe77dfb48de.tar.gz
zsh-f62a71e9de3a98438e7d38040f145fe77dfb48de.tar.bz2
zsh-f62a71e9de3a98438e7d38040f145fe77dfb48de.zip
meta: update issue templates
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md22
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md17
-rw-r--r--.github/ISSUE_TEMPLATE/support.md7
3 files changed, 28 insertions, 18 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 2ac8c3769..ff55f36be 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,31 +1,39 @@
---
name: Bug report
about: Create a report to help us improve
-title: ''
labels: 'Type: bug'
-assignees: ''
---
+<!--
+Fill this out before posting. You can delete irrelevant sections, but
+an issue where no sections have been filled will be deleted without comment.
+-->
+
**Describe the bug**
-A clear and concise description of what the bug is.
+<!-- A clear and concise description of what the bug is. -->
**To Reproduce**
+<!--
Steps to reproduce the behavior:
1. Enable plugin '...'
2. Run command '...', _or_ try to complete command '...', _etc._
3. See error
+-->
**Expected behavior**
-A clear and concise description of what you expected to happen.
+<!-- A clear and concise description of what you expected to happen. -->
**Screenshots or recordings**
-If applicable, add screenshots or record an [asciinema session](https://asciinema.org/) to help explain your problem.
+<!--
+If applicable, add screenshots or record an asciinema session (https://asciinema.org/)
+to help explain your problem.
+-->
-**Desktop (please complete the following information):**
+**System:**
- OS: [e.g. macOS]
- Zsh version [e.g. 5.6]
- Terminal emulator [e.g. iTerm2]
**Additional context**
-Add any other context about the problem here.
+<!-- Add any other context about the problem here. -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index daabf7940..3243e0b0a 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,23 +1,26 @@
---
name: Feature request
about: Suggest an idea for Oh My Zsh
-title: ''
labels: 'Type: feature request'
-assignees: ''
---
+<!--
+Fill this out before posting. You can delete irrelevant sections, but
+an issue where no sections have been filled will be deleted without comment.
+-->
+
**Is your feature request related to a particular plugin or theme? If so, specify it.**
-The name of the plugin or theme you'd like us to improve.
+<!-- The name of the plugin or theme you'd like us to improve. -->
**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+<!-- A clear and concise description of what you want to happen. -->
**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
**Additional context**
-Add any other context or screenshots about the feature request here.
+<!-- Add any other context or screenshots about the feature request here. -->
diff --git a/.github/ISSUE_TEMPLATE/support.md b/.github/ISSUE_TEMPLATE/support.md
index 10b614b8f..3c69a7d5e 100644
--- a/.github/ISSUE_TEMPLATE/support.md
+++ b/.github/ISSUE_TEMPLATE/support.md
@@ -1,13 +1,12 @@
---
name: Support
about: Request support for any problem you're having with Oh My Zsh
-title: ''
labels: 'Type: support'
-assignees: ''
---
<!--
-1. Try to make sure the issue is due to Oh My Zsh
-2. Include as much information as possible
+1. Look for similar issues already posted (including closed ones)
+2. Include as much relevant information as possible
+3. Try to make sure the issue is due to Oh My Zsh
-->