summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorMarc Cornellà <hello@mcornella.com>2021-11-30 10:19:21 +0100
committerMarc Cornellà <hello@mcornella.com>2021-11-30 10:34:45 +0100
commit1c1d74c5ec49e5ab7e2d664e557c61745d1995e6 (patch)
tree51d141d7f72a3f71efe7f17ed497ae187d9a4104 /.github
parentf0f792fa6b207bc72453ae55011b6b44f678fb78 (diff)
downloadzsh-1c1d74c5ec49e5ab7e2d664e557c61745d1995e6.tar.gz
zsh-1c1d74c5ec49e5ab7e2d664e557c61745d1995e6.tar.bz2
zsh-1c1d74c5ec49e5ab7e2d664e557c61745d1995e6.zip
chore: update new issue templates
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml15
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report_omz.yml77
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.yml7
3 files changed, 90 insertions, 9 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index af2973fec..98f66b1d2 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -1,12 +1,11 @@
-name: Bug report
-description: Create a report to help us improve Oh My Zsh
-labels: 'Bug'
+name: Report a bug
+description: Report a bug that isn't caused by Oh My Zsh. If unsure, use this form
body:
- type: markdown
attributes:
value: |
## Self Check
- - Try searching existing [GitHub Issues](https://github.com/ohmyzsh/ohmyzsh/issues?q=is%3Aissue) (open or closed) for similar issues.
+ - Look for similar errors in existing [GitHub Issues](https://github.com/ohmyzsh/ohmyzsh/issues?q=is%3Aissue) (open or closed).
- Try reaching out on the [Discord server](https://discord.gg/ohmyzsh) for help.
- type: textarea
validations:
@@ -41,21 +40,21 @@ body:
validations:
required: true
attributes:
- label: OS / Distro
- placeholder: e.g. Windows 10, Ubuntu 20.04, Arch Linux, macOS 10.15...
+ label: OS / Linux distribution
+ placeholder: Windows 10, Ubuntu 20.04, Arch Linux, macOS 10.15...
- type: input
validations:
required: true
attributes:
label: Zsh version
description: Run `echo $ZSH_VERSION` to check.
- placeholder: e.g. 5.6
+ placeholder: "5.6"
- type: input
validations:
required: true
attributes:
label: Terminal emulator
- placeholder: e.g. iTerm2, Gnome Terminal...
+ placeholder: iTerm2, GNOME Terminal, Terminal.app...
- type: dropdown
attributes:
label: If using WSL on Windows, which version of WSL
diff --git a/.github/ISSUE_TEMPLATE/bug_report_omz.yml b/.github/ISSUE_TEMPLATE/bug_report_omz.yml
new file mode 100644
index 000000000..96f5ad934
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report_omz.yml
@@ -0,0 +1,77 @@
+name: Report a bug in Oh My Zsh
+description: Create a report to help us improve Oh My Zsh
+labels: ['Bug']
+body:
+ - type: markdown
+ attributes:
+ value: |
+ ## Self Check
+ - **Make sure this bug only happens with Oh My Zsh enabled**.
+ - Look for similar errors in existing [GitHub Issues](https://github.com/ohmyzsh/ohmyzsh/issues?q=is%3Aissue) (open or closed).
+ - Try reaching out on the [Discord server](https://discord.gg/ohmyzsh) for help.
+ - type: textarea
+ validations:
+ required: true
+ attributes:
+ label: Describe the bug
+ description: A clear description of what the bug is.
+ - type: textarea
+ validations:
+ required: true
+ attributes:
+ label: Steps to reproduce
+ description: |
+ Steps to reproduce the problem.
+ placeholder: |
+ For example:
+ 1. Enable plugin '...'
+ 2. Run command '...' or try to complete command '...'
+ 3. See error
+ - type: textarea
+ validations:
+ required: true
+ attributes:
+ label: Expected behavior
+ description: A brief description of what should happen.
+ - type: textarea
+ attributes:
+ label: Screenshots and recordings
+ description: |
+ If applicable, add screenshots to help explain your problem. You can also record an asciinema session: https://asciinema.org/
+ - type: input
+ validations:
+ required: true
+ attributes:
+ label: OS / Linux distribution
+ placeholder: Windows 10, Ubuntu 20.04, Arch Linux, macOS 10.15...
+ - type: input
+ validations:
+ required: true
+ attributes:
+ label: Zsh version
+ description: Run `echo $ZSH_VERSION` to check.
+ placeholder: "5.6"
+ - type: input
+ validations:
+ required: true
+ attributes:
+ label: Oh My Zsh version
+ description: Run `omz version` to check.
+ placeholder: master (bf303965)
+ - type: input
+ validations:
+ required: true
+ attributes:
+ label: Terminal emulator
+ placeholder: iTerm2, GNOME Terminal, Terminal.app...
+ - type: dropdown
+ attributes:
+ label: If using WSL on Windows, which version of WSL
+ description: Run `wsl -l -v` to check.
+ options:
+ - WSL1
+ - WSL2
+ - type: textarea
+ attributes:
+ label: Additional context
+ description: Add any other context about the problem here. This can be themes, plugins, custom settings...
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
index dc4baf2b1..ac966dfd9 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -1,7 +1,12 @@
name: Feature request
description: Suggest a feature for Oh My Zsh
-labels: 'Feature'
+labels: ["Feature"]
body:
+ - type: markdown
+ attributes:
+ value: |
+ ## Self Check
+ - Look for similar features in existing [GitHub Issues](https://github.com/ohmyzsh/ohmyzsh/issues?q=is%3Aissue) (open or closed).
- type: input
attributes:
label: If the feature request is for a plugin or theme, specify it here.