Skip to content

Commit 555a2a2

Browse files
authored
Merge pull request #2 from storyprotocol/feat/add_gh_templates
[feat] add issue and pr templates
2 parents 7a4530f + 3eb1c00 commit 555a2a2

File tree

6 files changed

+127
-0
lines changed

6 files changed

+127
-0
lines changed
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Environment (please complete the following information):**
27+
- Browser or Nodejs
28+
- Browser [e.g. chrome, safari]
29+
- Browser Version [e.g. 22]
30+
- Node Version
31+
32+
**Additional context**
33+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Story Protocol Official Discord
4+
url: https://discord.gg/storyprotocol
5+
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.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/task.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Task
3+
about: Create a regular work item to be picked up by a contributor.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Description and context
11+
<!--- Write a description or todo list as the scope. A task should be: -->
12+
<!--- Actionable: can be acted on right away. -->
13+
<!--- Clearly defined scope: has precise limits/boundaries. -->
14+
<!--- Small scope: break complex tasks into smaller ones if they involve multiple system parts, multiple people/PRs, or parallelizable work. -->
15+
16+
## Suggested solution
17+
<!--- Optionally write a description of suggested solution for this feature request -->
18+
19+
## Definition of done
20+
<!--- Describe completion: e.g. code merged, deployment is done, or release published etc. -->
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Tracking issue
3+
about: Tracking issues are task lists used to better organize regular work items.
4+
title: 'Tracking issue for *ADD_PROJECT* - *ADD_COMPONENT*'
5+
labels: 'epic'
6+
assignees: ''
7+
8+
---
9+
10+
This issue is for grouping *ADD_COMPONENT* related tasks that are necessary for *ADD_PROJECT*.
11+
12+
### Other tracking issues for the same project:
13+
<!--- Link related tracking issues within the project for easier navigation. -->
14+
<!--- Assign tasks to the appropriate tracking issue if there is more than one. -->
15+
16+
- #XXXX
17+
- #XXXX
18+
- #XXXX
19+
20+
<!--- Subtasks MUST be inside the ``` -> ``` code block. -->
21+
```[tasklist]
22+
### Task list
23+
- [ ] XXXX
24+
- [ ] XXXX
25+
```

.github/pull_request_template.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## Description
2+
<!-- Add a description of the changes that this PR introduces -->
3+
Example:
4+
This pr adds user login function, includes:
5+
6+
- 1. add user login page.
7+
- 2. ...
8+
9+
## Test Plan
10+
<!-- The test plan section indicates detailed steps on how to verify and test code changes.
11+
You can list the test cases or test steps that need to be performed.-->
12+
Example:
13+
- 1. Use different test accounts for login tests, including correct user names and passwords, and incorrect user names and passwords.
14+
- 2. ...
15+
16+
## Related Issue
17+
<!-- The related Issue section can indicate which issue or task the Pull Request is related with -->
18+
19+
Example: Issue #123
20+
21+
## Notes
22+
<!-- The Important Matters section can alert others to special requirements or matters that need extra attention -->
23+
24+
- Example: Links and navigation need to be added to the front-end interface

0 commit comments

Comments
 (0)