From b255987c5cfb2deef96b8ab12a1e65dcf789beb1 Mon Sep 17 00:00:00 2001
From: Andy Wu <bwu2sfu@gmail.com>
Date: Wed, 17 Apr 2024 13:54:03 -0700
Subject: [PATCH] [feat] add issue and pr templates

---
 .github/ISSUE_TEMPLATE/bug_report.md      | 33 +++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yaml        |  5 ++++
 .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++
 .github/ISSUE_TEMPLATE/task.md            | 20 ++++++++++++++
 .github/ISSUE_TEMPLATE/tracking_issue.md  | 25 +++++++++++++++++
 .github/pull_request_template.md          | 24 +++++++++++++++++
 6 files changed, 127 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/config.yaml
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 create mode 100644 .github/ISSUE_TEMPLATE/task.md
 create mode 100644 .github/ISSUE_TEMPLATE/tracking_issue.md
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..8d50b67
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - Browser or Nodejs
+ - Browser [e.g. chrome, safari]
+ - Browser Version [e.g. 22]
+ - Node Version
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml
new file mode 100644
index 0000000..3de509e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yaml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Story Protocol Official Discord
+    url: https://discord.gg/storyprotocol
+    about: If you're a user, this is the fastest way to get help. Do not give your wallet private key or mnemonic words to anyone.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..bbcbbe7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md
new file mode 100644
index 0000000..27b5b34
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/task.md
@@ -0,0 +1,20 @@
+---
+name: Task
+about: Create a regular work item to be picked up by a contributor.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Description and context
+<!--- Write a description or todo list as the scope. A task should be: -->
+<!--- Actionable: can be acted on right away. -->
+<!--- Clearly defined scope: has precise limits/boundaries. -->
+<!--- Small scope: break complex tasks into smaller ones if they involve multiple system parts, multiple people/PRs, or parallelizable work. -->
+
+## Suggested solution
+<!--- Optionally write a description of suggested solution for this feature request -->
+
+## Definition of done
+<!--- Describe completion: e.g. code merged, deployment is done, or release published etc. -->
diff --git a/.github/ISSUE_TEMPLATE/tracking_issue.md b/.github/ISSUE_TEMPLATE/tracking_issue.md
new file mode 100644
index 0000000..efa993f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/tracking_issue.md
@@ -0,0 +1,25 @@
+---
+name: Tracking issue
+about: Tracking issues are task lists used to better organize regular work items.
+title: 'Tracking issue for *ADD_PROJECT* - *ADD_COMPONENT*'
+labels: 'epic'
+assignees: ''
+
+---
+
+This issue is for grouping *ADD_COMPONENT* related tasks that are necessary for *ADD_PROJECT*.
+
+### Other tracking issues for the same project:
+<!--- Link related tracking issues within the project for easier navigation. -->
+<!--- Assign tasks to the appropriate tracking issue if there is more than one. -->
+
+- #XXXX
+- #XXXX
+- #XXXX
+
+<!--- Subtasks MUST be inside the ``` -> ``` code block. -->
+```[tasklist]
+### Task list
+- [ ] XXXX
+- [ ] XXXX
+```
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..e5b24e2
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,24 @@
+## Description
+<!-- Add a description of the changes that this PR introduces -->
+Example:
+This pr adds user login function, includes：
+
+- 1. add user login page.
+- 2. ...
+
+## Test Plan 
+<!-- The test plan section indicates detailed steps on how to verify and test code changes. 
+You can list the test cases or test steps that need to be performed.-->
+Example: 
+- 1. Use different test accounts for login tests, including correct user names and passwords, and incorrect user names and passwords.
+- 2. ...
+
+## Related Issue
+<!-- The related Issue section can indicate which issue or task the Pull Request is related with -->
+
+Example: Issue #123
+
+## Notes
+<!-- The Important Matters section can alert others to special requirements or matters that need extra attention -->
+
+- Example: Links and navigation need to be added to the front-end interface
\ No newline at end of file