📝 add issue form templates

2023-01-14 14:31:04 +08:00
parent 19ff0746d3
commit 487e0cd1c0
4 changed files with 127 additions and 13 deletions
--- a/.github/ISSUE_TEMPLATE/bug-report.yml
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,76 @@
+name: Bug report
+description: Problems with the software
+title: "[Bug] "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you very much for your feedback!
+
+        有关讨论、建议或者咨询的内容请去往[讨论区](https://github.com/tw93/Pake/discussions)。
+
+        For suggestions or help, please consider using [Github Discussion](https://github.com/tw93/Pake/discussions) instead.
+  - type: checkboxes
+    attributes:
+      label: Search before asking
+      description: >
+        🙊 辛苦提 bug 前，去找一下 [历史](https://github.com/tw93/Pake/issues?q=) 是否有提。辛苦提供系统版本、录屏或者截图、复现路径，期待解决的点——这几个说明能帮助我更好的解决问题，此外假如是讨论，建议辛苦去 [Discussions](https://github.com/tw93/Pake/discussions) 看看是否有类似的讨论。
+
+        🙊 Check out [Issues](https://github.com/tw93/Pake/issues?q=) before reporting. Please provide your system version, screencasts, screenshots, way to reproduce, and the expected result – helpful for me to understand and fix up this issue! Besides, for suggestions or something else, head to [Pake's Discussions Platform](https://github.com/tw93/Pake/discussions).
+      options:
+        - label: >
+            我在 [issues](https://github.com/tw93/Pake/issues?q=) 列表中搜索，没有找到类似的内容。
+
+            I searched in the [issues](https://github.com/tw93/Pake/issues?q=) and found nothing similar.
+          required: true
+  - type: textarea
+    attributes:
+      label: Pake version
+      description: >
+        Please provide the version of Pake you are using. If you are using the master/dev branch, please provide the commit id.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: System version
+      description: >
+        Please provide the version of System you are using.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Node.js version
+      description: >
+        Please provide the Node.js version.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Minimal reproduce step
+      description: Please try to give reproducing steps to facilitate quick location of the problem.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: What did you expect to see?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: What did you see instead?
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Anything else?
+  - type: checkboxes
+    attributes:
+      label: Are you willing to submit a PR?
+      description: >
+        We look forward to the community of developers or users helping solve Pake problems together. If you are willing to submit a PR to fix this problem, please check the box.
+      options:
+        - label: I'm willing to submit a PR!
+  - type: markdown
+    attributes:
+      value: "Thanks for completing our form!"
--- a/.github/ISSUE_TEMPLATE/bug.md
+++ b/.github/ISSUE_TEMPLATE/bug.md
@@ -1,13 +0,0 @@
---
-name: Bug
-about: 讨论建议咨询请去讨论区 / Please go to discussion for suggestions.
-title: ""
-labels: ""
-assignees: ""
---
-
-<!--
-    🙊 辛苦提 bug 前，去找一下 [历史](https://github.com/tw93/Pake/issues?q=) 是否有提。辛苦提供系统版本、录屏或者截图、复现路径，期待解决的点——这几个说明能帮助我更好的解决问题，此外假如是讨论，建议辛苦去 [Discussions](https://github.com/tw93/Pake/discussions) 看看。
-
-    🙊 Check out [Issues](https://github.com/tw93/Pake/issues?q=) before reporting. Please provide your system version, screencasts, screenshots, way to reproduce, and the expected result – helpful for me to understand and fix up this issue! Besides, for suggestions or something else, head to [Pake's Discussions Platform](https://github.com/tw93/Pake/discussions).
-->
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask a question or get support
+    url: https://github.com/tw93/Pake/discussions/categories/q-a
+    about: Ask a question or request support for Pake
--- a/.github/ISSUE_TEMPLATE/feature.yml
+++ b/.github/ISSUE_TEMPLATE/feature.yml
@@ -0,0 +1,46 @@
+name: Feature
+description: Add new feature, improve code, and more
+labels: [ "enhancement" ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you very much for your feature proposal!
+  - type: checkboxes
+    attributes:
+      label: Search before asking
+      description: >
+        Please search [issues](https://github.com/tw93/Pake/issues?q=) to check if your issue has already been reported.
+      options:
+        - label: >
+            我在 [issues](https://github.com/tw93/Pake/issues?q=) 列表中搜索，没有找到类似的内容。
+
+            I searched in the [issues](https://github.com/tw93/Pake/issues?q=) and found nothing similar.
+          required: true
+  - type: textarea
+    attributes:
+      label: Motivation
+      description: Describe the motivations for this feature, like how it fixes the problem you meet.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Solution
+      description: Describe the proposed solution and add related materials like links if any.
+  - type: textarea
+    attributes:
+      label: Alternatives
+      description: Describe other alternative solutions or features you considered, but rejected.
+  - type: textarea
+    attributes:
+      label: Anything else?
+  - type: checkboxes
+    attributes:
+      label: Are you willing to submit a PR?
+      description: >
+        We look forward to the community of developers or users helping develop Pake features together. If you are willing to submit a PR to implement the feature, please check the box.
+      options:
+        - label: I'm willing to submit a PR!
+  - type: markdown
+    attributes:
+      value: "Thanks for completing our form!"