Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feat] add issue and pr templates #255

Merged
merged 1 commit into from
Apr 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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/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
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ docs/

.idea/
.vscode
.github/
node_modules/

# OSX
Expand Down
Loading