Revised issue and PR templates (#1133)

* Update feature_request.yml

* Update feature_request.yml

* Update feature_request.yml

* Update feature_request.yml

* Update feature_request.yml

* Update feature_request.yml

* Update bug_report.yml

* Update bug_report.yml

* Update bug_report.yml

* Update bug_report.yml

* Update pull_request_template.md

* Update pull_request_template.md

* Update feature_request.yml

* Update bug_report.yml

* Update feature_request.yml

* Update pull_request_template.md

* Update .github/pull_request_template.md

Co-authored-by: Lukas Pistrol <[email protected]>

* Update .github/ISSUE_TEMPLATE/bug_report.yml

Co-authored-by: Lukas Pistrol <[email protected]>

---------

Co-authored-by: Lukas Pistrol <[email protected]>

Author: austincondiff

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,22 +1,22 @@
 name: 🐞 Bug report
 description: Something is not working as expected.
-title: 🐞 YOUR_DESCRIPTION
+title: 🐞 <bug title>
 labels: bug
 
 body:
   - type: textarea
     attributes:
       label: Description
-      description: >-
-        A clear and concise description of what the bug is.
+      placeholder: >-
+        A clear and concise description of what the bug is...
     validations:
       required: true
 
   - type: textarea
     attributes:
       label: To Reproduce
       description: >-
-        Steps to reproduce the behavior.
+        Steps to reliably reproduce the behavior.
       placeholder: |
         1. Go to '...'
         2. Click on '....'
@@ -27,26 +27,30 @@ body:
 
   - type: textarea
     attributes:
-      label: Expected behavior
-      description: >-
-        A clear and concise description of what you expected to happen.
+      label: Expected Behavior
+      placeholder: >-
+        A clear and concise description of what you expected to happen...
     validations:
       required: true
 
   - type: textarea
     attributes:
-      label: Version information
+      label: Version Information
       description: >-
          click on the version number on the welcome screen
       value: |
-        CodeEdit: [e.g. 1.0]
-        macOS: [e.g. 12.3.0]
-        Xcode: [e.g. 13.3]
-    validations:
-      required: true
+        CodeEdit: [e.g. 0.0.x-alpha.y]
+        macOS: [e.g. 13.2.1]
+        Xcode: [e.g. 14.2]
+
+  - type: textarea
+    attributes:
+      label: Additional Context
+      placeholder: >-
+        Any other context or considerations about the bug...
       
   - type: textarea
     attributes:
-      label: Additional context
-      description: >-
-        Add any other context about the problem here.
+      label: Screenshots
+      placeholder: >-
+        If applicable, please provide relevant screenshots or screen recordings...

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,36 +1,31 @@
 name: ✨ Feature request
 description: Suggest an idea for this project
-title: ✨ YOUR_DESCRIPTION
+title: ✨ <feature title>
 labels: enhancement
 
 body:
-  - type: input
-    attributes:
-      label: Is your feature request related to a problem? Please describe.
-      placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-    validations:
-      required: false
-
   - type: textarea
     attributes:
-      label: Describe the solution you'd like
+      label: Description
       placeholder: >-
-        A clear and concise description of what you want to happen.
+        A clear and concise description of what you would like to happen...
     validations:
       required: true
 
   - type: textarea
     attributes:
-      label: Describe alternatives you've considered
+      label: Alternatives Considered
       placeholder: >-
-        A clear and concise description of any alternative solutions or features you've considered.
-    validations:
-      required: true
+        Any alternative solutions or features you've considered...
 
   - type: textarea
     attributes:
-      label: Additional context
+      label: Additional Context
       placeholder: >-
-        Add any other context or screenshots about the feature request here.
-    validations:
-      required: true
+        Any other context or considerations about the feature request...
+      
+  - type: textarea
+    attributes:
+      label: Screenshots
+      placeholder: >-
+        If applicable, please provide relevant screenshots or screen recordings...

.github/pull_request_template.md

@@ -1,22 +1,29 @@
-# Description
+<!--- IMPORTANT: If this PR addresses multiple unrelated issues, it will be closed until separated. -->
+
+### Description
 
 <!--- REQUIRED: Describe what changed in detail -->
 
-# Related Issue
+### Related Issues
+
+<!--- REQUIRED: Tag all related issues (e.g. * #123) -->
+<!--- If this PR resolves the issue please specify (e.g. * closes #123) -->
+<!--- If this PR addresses multiple issues, these issues must be related to one other -->
 
-<!--- REQUIRED: Tag all related issues (e.g. * #23) -->
 * #ISSUE_NUMBER
 
-# Checklist
+### Checklist
 
 <!--- Add things that are not yet implemented above -->
+
 - [ ] I read and understood the [contributing guide](https://github.com/CodeEditApp/CodeEdit/blob/main/CONTRIBUTING.md) as well as the [code of conduct](https://github.com/CodeEditApp/CodeEdit/blob/main/CODE_OF_CONDUCT.md)
+- [ ] The issues this PR addresses are related to each other
 - [ ] My changes generate no new warnings
 - [ ] My code builds and runs on my machine
+- [ ] My changes are all related to the related issue above
 - [ ] I documented my code
-- [ ] Review requested
 
-# Screenshots
+### Screenshots
 
 <!--- REQUIRED: if issue is UI related -->