Skip to content

Commit

Permalink
Merge pull request #21 from storyprotocol/feat/add_gh_templates
Browse files Browse the repository at this point in the history
[feat] add issue and pr templates
  • Loading branch information
AndyBoWu authored Apr 17, 2024
2 parents bf52dc6 + 692d381 commit e4f7137
Show file tree
Hide file tree
Showing 6 changed files with 127 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
@@ -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. -->
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/tracking_issue.md
Original file line number Diff line number Diff line change
@@ -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
```
24 changes: 24 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit e4f7137

Please sign in to comment.