From 4efcc59d4f96b1863137358673c444f20c4fac0d Mon Sep 17 00:00:00 2001
From: zhyncs <me@zhyncs.com>
Date: Thu, 18 Jul 2024 04:58:11 +1000
Subject: [PATCH] misc: add issue and pr template (#638)

---
 .github/ISSUE_TEMPLATE/1-bug-report.yml      | 36 ++++++++++++++++++++
 .github/ISSUE_TEMPLATE/2-feature-request.yml | 17 +++++++++
 .github/pull_request_template.md             | 15 ++++++++
 3 files changed, 68 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/1-bug-report.yml
 create mode 100644 .github/ISSUE_TEMPLATE/2-feature-request.yml
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml
new file mode 100644
index 000000000..6132b2b67
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml
@@ -0,0 +1,36 @@
+name: 🐞 Bug report
+description: Create a report to help us reproduce and fix the bug
+title: "[Bug] "
+labels: ['Bug']
+
+body:
+- type: checkboxes
+  attributes:
+    label: Checklist
+    options:
+    - label: 1. I have searched related issues but cannot get the expected help.
+    - label: 2. The bug has not been fixed in the latest version.
+- type: textarea
+  attributes:
+    label: Describe the bug
+    description: A clear and concise description of what the bug is.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Reproduction
+    description: |
+      1. What command or script did you run?
+    placeholder: |
+      A placeholder for the command.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Environment
+    description: |
+      Please provide necessary environment information here.
+    placeholder: Environment here.
+    render: Shell
+  validations:
+    required: true
diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yml b/.github/ISSUE_TEMPLATE/2-feature-request.yml
new file mode 100644
index 000000000..5ab369f8b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/2-feature-request.yml
@@ -0,0 +1,17 @@
+name: 🚀 Feature request
+description: Suggest an idea for this project
+title: "[Feature] "
+
+body:
+- type: textarea
+  attributes:
+    label: Motivation
+    description: |
+      A clear and concise description of the motivation of the feature.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Related resources
+    description: |
+      If there is an official code release or third-party implementations, please also provide the information here, which would be very helpful.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000000000..147086400
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,15 @@
+Thank you for your contribution, we really appreciate it. The following instructions will help improve your pull request and make it easier to receive feedback. If there are any items you don't understand, don't worry. Just submit the pull request and ask the maintainers for help.
+
+## Motivation
+
+Please explain the motivation behind this PR and the goal you aim to achieve with it.
+
+## Modification
+
+Briefly describe the changes made in this PR.
+
+## Checklist
+
+1. Ensure pre-commit or other linting tools are used to fix potential lint issues.
+2. Confirm that modifications are covered by complete unit tests. If not, please add more unit tests for correctness.
+3. Modify documentation as needed, such as docstrings or example tutorials.