Create bugTemplate.yml (#20)

* Create bugTemplate.yml * Create featureRequest.yml * Update bugTemplate.yml * Update featureRequest.yml
Hutch79 · Aug 14, 2024 · b062c70 · b062c70
1 parent 6850a14
commit b062c70
Show file tree

Hide file tree

Showing 2 changed files with 98 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bugTemplate.yml b/.github/ISSUE_TEMPLATE/bugTemplate.yml
@@ -0,0 +1,63 @@
+name: 🐛 Bug Report
+description: Create a Bug report to help us improve.
+labels: bug
+body:
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Welcome!
+      description: |
+        The issue tracker is for reporting bugs and feature requests only.
+        For support questions, please use the [Q&A Discussions](https://github.com/Hutch79/Your-Lab/discussions/categories/q-a).
+
+        DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.
+
+      options:
+        - label: Yes, I've searched similar issues on [GitHub](https://github.com/Hutch79/Your-Lab/issues) and didn't find any.
+          required: true
+        - label: Yes, I've searched similar issues on the [Discussions](https://github.com/Hutch79/Your-Lab/discussions?discussions_q=) and didn't find any.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: What did you do?
+      description: |
+        How to write a good bug report?
+
+        - Respect the issue template as much as possible.
+        - The title should be short and descriptive.
+        - Explain the conditions which led you to report this issue: the context.
+        - The context should lead to something, an idea or a problem that you’re facing.
+        - Remain clear and concise.
+        - Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown)
+      placeholder: What did you do?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: What did you see instead?
+      placeholder: What did you see instead?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: What is your environment & configuration?
+      description: version, platform, ...
+      placeholder: Add information here.
+      value: |
+        ```yaml
+        # (paste your configuration/docker-compose here)
+        ```
+
+        Add more configuration information here.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: If applicable, please paste the log output
+      placeholder: Paste your output here.
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/featureRequest.yml b/.github/ISSUE_TEMPLATE/featureRequest.yml
@@ -0,0 +1,35 @@
+name: Feature Request
+description: Suggest an idea for this project.
+labels: feature
+body:
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Welcome!
+      description: |
+        The issue tracker is for reporting bugs and feature requests only.
+        For support questions, please use the [Q&A Discussions](https://github.com/Hutch79/Your-Lab/discussions/categories/q-a).
+
+        DO NOT FILE ISSUES FOR GENERAL SUPPORT QUESTIONS.
+
+      options:
+        - label: Yes, I've searched similar issues on [GitHub](https://github.com/Hutch79/Your-Lab/issues) and didn't find any.
+          required: true
+        - label: Yes, I've searched similar issues on the [Discussions](https://github.com/Hutch79/Your-Lab/discussions?discussions_q=) and didn't find any.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: What would you like to see?
+      description: |
+        How to write a good feature request?
+
+        - The title should be short and descriptive.
+        - Explain what your request is about.
+        - The context should lead to something, an idea or a problem that you’re facing.
+        - What would be the benefit if this feature got implemented?
+        - Remain clear and concise.
+        - Format your messages to help the reader focus on what matters and understand the structure of your message, use [Markdown syntax](https://help.github.com/articles/github-flavored-markdown)
+      placeholder: Feature xyz is missing
+    validations:
+      required: true