beab76edfce3500b2fb357c69f3d4fb2a17898fe

Author
Larson Carter <larsoncarter@blazermail.net>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

Update issues and PR templates (#8471)

Closes #8471

Diff

  1diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
  2index 076c35544409154ae2ed945d92bf7f009e43c774..7c1cb89671b4d544ce6b8b016aaedc31f1c6addc 100644
  3--- a/.github/ISSUE_TEMPLATE/bug_report.md
  4+++ b/.github/ISSUE_TEMPLATE/bug_report.md
  5@@ -1,6 +1,7 @@
  6 ---
  7 name: Bug report
  8-about: Create a report to help us improve
  9+about: Create a report to help us improve Oh My Zsh
 10+labels: 'Type: support'
 11 
 12 ---
 13 
 14@@ -10,29 +11,26 @@ an issue where no sections have been filled will be deleted without comment.
 15 -->
 16 
 17 **Describe the bug**
 18-<!-- A clear and concise description of what the bug is. -->
 19+A clear description of what the bug is.
 20 
 21 **To Reproduce**
 22-<!--
 23-Steps to reproduce the behavior:
 24-1. Enable plugin '...'
 25-2. Run command '...', _or_ try to complete command '...', _etc._
 26+Steps to reproduce the behavior, for example:
 27+1. Enable this plugin '...'
 28+2. Run command '...' or try the autocomplete command '...'
 29 3. See error
 30--->
 31 
 32 **Expected behavior**
 33-<!-- A clear and concise description of what you expected to happen. -->
 34+A brief description of what should happen.
 35 
 36-**Screenshots or recordings**
 37-<!--
 38-If applicable, add screenshots or record an asciinema session (https://asciinema.org/)
 39-to help explain your problem.
 40--->
 41+**Screenshots and/or Recordings**
 42+If applicable, add screenshots to help explain your problem.
 43+You can also record an asciinema session: https://asciinema.org/
 44 
 45-**System:**
 46- - OS: [e.g. macOS]
 47- - Zsh version [e.g. 5.6]
 48+**Desktop (please complete the following information):**
 49+ - OS / Distro: [e.g. Arch Linux, macOS]
 50+ - Latest ohmyzsh Update?: [e.g. Yes/No]
 51+ - ZSH Version: [e.g. 5.6]
 52  - Terminal emulator [e.g. iTerm2]
 53 
 54 **Additional context**
 55-<!-- Add any other context about the problem here. -->
 56+Add any other context about the problem here. This can be themes, plugins, custom configs.
 57diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
 58index d9c324a55a92870e431c8ccc41c6978fd3448c5b..346eabaea14e68e373dac0d7498c5dc3860191b1 100644
 59--- a/.github/ISSUE_TEMPLATE/feature_request.md
 60+++ b/.github/ISSUE_TEMPLATE/feature_request.md
 61@@ -11,16 +11,16 @@ an issue where no sections have been filled will be deleted without comment.
 62 -->
 63 
 64 **Is your feature request related to a particular plugin or theme? If so, specify it.**
 65-<!-- The name of the plugin or theme you'd like us to improve. -->
 66+The name of the plugin or theme that you would like us to improve. [...]
 67 
 68 **Is your feature request related to a problem? Please describe.**
 69-<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
 70+A description of what the problem is. Ex. I'm always frustrated when [...]
 71 
 72 **Describe the solution you'd like**
 73-<!-- A clear and concise description of what you want to happen. -->
 74+A description of what you want to happen.
 75 
 76 **Describe alternatives you've considered**
 77-<!-- A clear and concise description of any alternative solutions or features you've considered. -->
 78+A description of any alternative solutions or features you've considered. This can also include other plugins or aliases.
 79 
 80 **Additional context**
 81-<!-- Add any other context or screenshots about the feature request here. -->
 82+Add any other context or screenshots about the feature request here. Also if you have any PRs related to this issue that are already open that you would like us to look at.
 83diff --git a/.github/ISSUE_TEMPLATE/support.md b/.github/ISSUE_TEMPLATE/support.md
 84index 3c69a7d5ec2641bd9e2c98c88384382b12bdd9d4..d2638412e08eaa38bb9479b5e733d17c9cac5f78 100644
 85--- a/.github/ISSUE_TEMPLATE/support.md
 86+++ b/.github/ISSUE_TEMPLATE/support.md
 87@@ -5,8 +5,6 @@ labels: 'Type: support'
 88 
 89 ---
 90 
 91-<!--
 92 1. Look for similar issues already posted (including closed ones)
 93 2. Include as much relevant information as possible
 94 3. Try to make sure the issue is due to Oh My Zsh
 95--->
 96diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
 97new file mode 100644
 98index 0000000000000000000000000000000000000000..6bcb90efe169ad43ec01ff1b34932d6fab86ca22
 99--- /dev/null
100+++ b/.github/PULL_REQUEST_TEMPLATE.md
101@@ -0,0 +1,17 @@
102+## Standards checklist:
103+
104+- [ ] The PR title is descriptive.
105+- [ ] The PR doesn't replicate another PR which is already open.
106+- [ ] I have read the contribution guide and followed all the instructions.
107+- [ ] The code follows the code style guide detailed in the wiki.
108+- [ ] The code is mine or it's from somewhere with an MIT-compatible license.
109+- [ ] The code is efficient, to the best of my ability, and does not waste computer resources.
110+- [ ] The code is stable and I have tested it myself, to the best of my abilities.
111+
112+## Changes:
113+
114+- [...]
115+
116+## Other comments:
117+
118+...