Skip to content

Commit 57d8056

Browse files
kaihiroikaihiroi
committed
chore: update issue and pull request templates
1 parent b597872 commit 57d8056

11 files changed

+221
-114
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,34 @@
22
name: Bug report
33
about: Create a report to help us improve
44
title: "[BUG] "
5-
labels: 'bug, priority: medium, status: todo'
5+
labels: 'type: bug, status: todo'
66
assignees: ''
77

88
---
99

10-
**Describe the bug**
10+
## Description
11+
1112
A clear and concise description of what the bug is.
1213

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
14+
## Steps to Reproduce
15+
1516
1. Go to '...'
1617
2. Click on '....'
1718
3. Scroll down to '....'
1819
4. See error
1920

20-
**Expected behavior**
21+
## Expected behavior
22+
2123
A clear and concise description of what you expected to happen.
2224

23-
**Screenshots**
25+
## Screenshots
26+
2427
If applicable, add screenshots to help explain your problem.
2528

26-
**Versions (please complete the following information):**
29+
## Versions
2730
- Solc: [e.g. 0.8.24]
2831
- Foundry: [e.g. forge 0.2.0 (617dfc2 2024-03-29T00:21:19.015083000Z)]
2932

30-
**Additional context**
33+
## Additional context
34+
3135
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,23 @@
22
name: Feature request
33
about: Suggest an idea for this project
44
title: "[Feature Request] "
5-
labels: 'feature, priority: medium, status: todo'
5+
labels: 'type: feature, status: todo'
66
assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
10+
## Problem
11+
1112
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1213

13-
**Describe the solution you'd like**
14+
## Solution
15+
1416
A clear and concise description of what you want to happen.
1517

16-
**Describe alternatives you've considered**
18+
## Alternatives
19+
1720
A clear and concise description of any alternative solutions or features you've considered.
1821

19-
**Additional context**
22+
## Additional context
23+
2024
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/new_release.md

Lines changed: 0 additions & 56 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/release_discussion.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: New release discussion
3+
about: Create a discussion issue for new release
4+
title: "[Discussion] vX.X.X Release Planning 🚀"
5+
labels: 'type: release, type: discussion, status: in-progress, good first issue'
6+
assignees: ''
7+
8+
---
9+
10+
## Overview
11+
12+
This discussion thread is to plan the features and bug fixes to be included in the upcoming release of the `mc` project. We aim to gather input from all users and team members to prioritize and finalize the content of this release.
13+
14+
## Proposed Features
15+
16+
Please list any features you would like to propose for inclusion in this release. Include a brief description.
17+
18+
```
19+
## [Add/Update/Remove] feature(s)
20+
- [link to feature request issue] or [short description]
21+
```
22+
23+
## Bug Fixes
24+
25+
If you have identified any bugs that need to be addressed in this release, please list them here. If it is urgent, consider including it in a hotfix.
26+
27+
```
28+
## Fix bug(s)
29+
- [link to bug report issue] or [short description]
30+
```
31+
32+
## Follow-Up
33+
34+
We will regularly follow up on this discussion to track progress and ensure that all proposed items are addressed before the release.
35+
36+
---
37+
38+
Thank you for your contributions!

‎.github/ISSUE_TEMPLATE/support_request.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,27 @@
22
name: Support request
33
about: Request support or ask a question
44
title: "[Support] "
5-
labels: 'priority: medium, status: todo, support'
5+
labels: 'type: support, status: todo'
66
assignees: ''
77

88
---
99

10-
**Describe your question or the support you need**
11-
A clear and concise description of what you need help with or what your question is.
10+
## Question
1211

13-
**What have you tried so far?**
14-
A clear and concise description of any methods you've tried to solve the problem or find an answer to your question.
12+
Please describe your question or the support you need in detail, including any specific issues you are encountering.
1513

16-
**Screenshots or code snippets**
17-
If applicable, add screenshots or code snippets to help explain your question or the issue you're facing.
14+
## Screenshots or code snippets
1815

19-
**Environment (please complete the following information):**
20-
Solc: [e.g. 0.8.24]
21-
Foundry: [e.g. forge 0.2.0 (617dfc2 2024-03-29T00:21:19.015083000Z)]
16+
If applicable, add screenshots or code snippets (formatted in Markdown) to help explain your question or the issue you're facing.
17+
18+
## Environment
19+
20+
Describe the environment you're using to run the `mc` project to solve the problem or answer your question.
21+
22+
- OS: [e.g. Windows 10, macOS 11.2]
23+
- Solc: [e.g. 0.8.24]
24+
- Foundry: [e.g. forge 0.2.0 (617dfc2 2024-03-29T00:21:19.015083000Z)]
25+
26+
## Additional context
2227

23-
**Additional context**
2428
Add any other context about the problem or question here.

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

‎.github/PULL_REQUEST_TEMPLATE/bug_fix.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug Fix
3+
about: Create a pull request for bug fix
4+
title: "[Bug Fix] "
5+
labels: 'type: bug, status: in-progress'
6+
assignees: ''
7+
8+
---
9+
10+
This pull request is to propose a bug fix for the `mc` project.
11+
12+
## Bug Description
13+
14+
- [link to bug report issue] or [short description]
15+
16+
- **Steps to Reproduce**: List the steps to reproduce the bug.
17+
- **Expected Behavior**: Describe what you expected to happen.
18+
- **Actual Behavior**: Describe what actually happened.
19+
- **Screenshots**: If applicable, please include screenshots that demonstrate the bug.
20+
21+
(Please include a summary of the changes and which issue to address.)
22+
23+
## Checklist
24+
25+
- [ ] My code follows the style guidelines of this project
26+
- [ ] I have commented my code, particularly in hard-to-understand areas
27+
- [ ] I have made corresponding changes to the documentation
28+
- [ ] My changes generate no new warnings
29+
- [ ] I have added tests that prove my fix works
30+
- [ ] New and existing unit tests pass locally with my changes
31+
32+
Please review the changes and provide feedback.

‎.github/PULL_REQUEST_TEMPLATE/new_feature.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: New Feature
3+
about: Create a pull request for new feature
4+
title: "[New Feature] "
5+
labels: 'type: feature, status: in-progress'
6+
assignees: ''
7+
8+
---
9+
10+
This pull request is to propose the new feature of the `mc` project.
11+
12+
## Feature Description
13+
14+
- [link to feature request issue] or [short description]
15+
16+
(Please include a summary of the changes and which issue to address. Please also include relevant motivation and context. List any dependencies that are required for this change. If applicable, please include screenshots about the feature.)
17+
18+
## Checklist
19+
20+
- [ ] My code follows the style guidelines of this project
21+
- [ ] I have commented my code, particularly in hard-to-understand areas
22+
- [ ] I have made corresponding changes to the documentation
23+
- [ ] My changes generate no new warnings
24+
- [ ] I have added tests that prove my feature works
25+
- [ ] New and existing unit tests pass locally with my changes
26+
27+
Please review the changes and provide feedback.

‎.github/PULL_REQUEST_TEMPLATE/new_release.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: New Release
3+
about: Create a pull request for new release
4+
title: "[Release] vX.X.X"
5+
labels: 'type: release, status: in-progress'
6+
assignees: ''
7+
8+
---
9+
10+
## Overview
11+
12+
This pull request is to propose the new release of the `mc` project, including features and bug fixes. Please review the changes and provide feedback.
13+
- [Release discussion]()
14+
15+
## Release Checklist
16+
17+
### Review and merge all related Pull Requests:
18+
19+
Ensure all tests pass and code is merged into `release` branch.
20+
21+
#### Breaking changes:
22+
23+
- [ ] [link to breaking change issue] or [short description]
24+
25+
#### Features:
26+
27+
- [ ] [link to feature request issue] or [short description]
28+
29+
#### Bug fixes:
30+
31+
- [ ] [link to bug report issue] or [short description]
32+
33+
### Update documentations:
34+
35+
- [ ] Update version number in relevant files
36+
- [ ] [CHANGELOG.md](../CHANGELOG.md)
37+
- [ ] [README.md](../README.md)
38+
- [ ] [package.json](../package.json)
39+
- [ ] [docs](../docs)
40+
41+
### Announces the release:
42+
43+
- [ ] Create Git tag and release notes
44+
- [ ] Announce the release
45+
- [ ] [X](https://x.com/ecdysis_xyz)
46+
47+
### Merge and register the release
48+
- [ ] Merge release branch into `main`
49+
- [ ] Register the release on Soldeer
50+
51+
## Release Managers
52+
53+
- @username1
54+
- @username2
55+
56+
Please review the changes, add any missing items, and follow the checklist to complete the release process. Ping the release managers with any questions or concerns.

‎.github/PULL_REQUEST_TEMPLATE/update_ci.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Update CI
3+
about: Create a pull request to update the CI/CD configuration
4+
title: "[CI] "
5+
labels: 'type: ci, status: in-progress'
6+
assignees: ''
7+
8+
---
9+
10+
This pull request is to propose a CI/CD update for the `mc` project.
11+
12+
## CI/CD Update
13+
14+
- [link to CI/CD issue] or [short description]
15+
16+
Please review the changes and provide feedback.

‎.github/PULL_REQUEST_TEMPLATE/update_docs.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Update Docs
3+
about: Create a pull request to update the documentation
4+
title: "[Docs] "
5+
labels: 'type: documentation, status: in-progress'
6+
assignees: ''
7+
8+
---
9+
10+
This pull request is to propose a documentation update for the `mc` project.
11+
12+
## Documentation Update
13+
14+
- [link to documentation issue] or [short description]
15+
16+
Please review the changes and provide feedback.

0 commit comments

Comments
 (0)