Browse Source

chore: update new issue templates

Marc Cornellà 2 years ago
parent
commit
1c1d74c5ec

+ 7 - 8
.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

+ 77 - 0
.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...

+ 6 - 1
.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.