Skip to content

Commit 52811d9

Browse files
kaihiroikaihiroi
authored
chore: update issue and pr templates (#58)
1 parent 0de4d66 commit 52811d9

11 files changed

+89
-55
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
4-
title: "[BUG] "
5-
labels: 'type: bug, status: todo'
6-
assignees: ''
7-
2+
name: Bug Report
3+
about: Report a bug to help us improve
4+
title: "[bug] "
5+
labels: "type: bug"
6+
assignees: ""
87
---
98

109
## Description

‎.github/ISSUE_TEMPLATE/doc_issue.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Documentation Issue
3+
about: Report an issue or suggest an improvement for the project documentation or its display on the site
4+
title: "[docs] "
5+
labels: "type: documentation"
6+
assignees: ""
7+
---
8+
9+
## Issue Type
10+
11+
Specify whether the issue is related to the document content or its display on the site.
12+
13+
- [ ] Document Content
14+
- [ ] Site Display
15+
16+
## Location
17+
18+
Specify the document or section where the issue is found. Provide links if possible.
19+
20+
- [link to the document]
21+
22+
## Description
23+
24+
A clear and concise description of what the issue is. Include any relevant details or context.

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
2-
name: Feature request
2+
name: Feature Request
33
about: Suggest an idea for this project
4-
title: "[Feature Request] "
5-
labels: 'type: feature, status: todo'
6-
assignees: ''
7-
4+
title: "[feature] "
5+
labels: "type: feature"
6+
assignees: ""
87
---
98

109
## Problem

‎.github/ISSUE_TEMPLATE/release_discussion.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,33 @@
11
---
2-
name: New release discussion
2+
name: New Release Discussion
33
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-
4+
title: "[discussion] vX.X.X Release Planning 🚀"
5+
labels: "type: release, type: discussion, status: in-progress, good first issue"
6+
assignees: ""
87
---
98

109
## Overview
1110

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.
11+
This discussion thread is to plan the features and bug fixes to be included in the upcoming `release X.X.X`. We aim to gather input from all users and team members to prioritize and finalize the content of this release.
1312

14-
## Proposed Features
13+
Please feel free to leave a comment if you have any features you would like to propose for inclusion in this release or if you have identified any bugs that need to be addressed. Include a brief description. If a bug is urgent, consider including it in a hotfix.
1514

16-
Please list any features you would like to propose for inclusion in this release. Include a brief description.
15+
## Candidates
1716

18-
```
19-
## [Add/Update/Remove] feature(s)
20-
- [link to feature request issue] or [short description]
21-
```
17+
### Feature
2218

23-
## Bug Fixes
19+
- [link to feature request issue] or [short description]
2420

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.
21+
### Bug Fix
2622

27-
```
28-
## Fix bug(s)
2923
- [link to bug report issue] or [short description]
30-
```
24+
25+
### Chore
26+
27+
- [link to chore issue] or [short description]
3128

3229
## Follow-Up
3330

3431
We will regularly follow up on this discussion to track progress and ensure that all proposed items are addressed before the release.
3532

36-
---
37-
3833
Thank you for your contributions!

‎.github/ISSUE_TEMPLATE/support_request.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
2-
name: Support request
2+
name: Support Request
33
about: Request support or ask a question
4-
title: "[Support] "
5-
labels: 'type: support, status: todo'
6-
assignees: ''
7-
4+
title: "[support] "
5+
labels: "type: support"
6+
assignees: ""
87
---
98

109
## Question

‎.github/PULL_REQUEST_TEMPLATE/bug_fix.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
name: Bug Fix
33
about: Create a pull request for bug fix
4-
title: "[Bug Fix] "
5-
labels: 'type: bug, status: in-progress'
6-
assignees: ''
7-
4+
title: "[bug fix] "
5+
labels: "type: bug, status: in-progress"
6+
assignees: ""
87
---
98

109
This pull request is to propose a bug fix for the `mc` project.

‎.github/PULL_REQUEST_TEMPLATE/new_feature.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
name: New Feature
33
about: Create a pull request for new feature
4-
title: "[New Feature] "
5-
labels: 'type: feature, status: in-progress'
6-
assignees: ''
7-
4+
title: "[feature] "
5+
labels: "type: feature, status: in-progress"
6+
assignees: ""
87
---
98

109
This pull request is to propose the new feature of the `mc` project.

‎.github/PULL_REQUEST_TEMPLATE/new_release.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
name: New Release
33
about: Create a pull request for new release
4-
title: "[Release] vX.X.X"
5-
labels: 'type: release, status: in-progress'
6-
assignees: ''
7-
4+
title: "[release] vX.X.X"
5+
labels: "type: release, status: in-progress"
6+
assignees: ""
87
---
98

109
## Overview

‎.github/PULL_REQUEST_TEMPLATE/refactor_request.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Refactor Request
3+
about: Suggest a code refactor
4+
title: "[refactor] "
5+
labels: "type: refactor"
6+
assignees: ""
7+
---
8+
9+
## Current Code
10+
11+
Describe the current code that needs refactoring.
12+
13+
## Suggested Refactor
14+
15+
Describe the proposed changes and improvements.
16+
17+
## Benefits
18+
19+
Explain the benefits of the refactor, such as improved readability or performance.
20+
21+
## Additional context
22+
23+
Add any other context or screenshots about the refactor request here.

‎.github/PULL_REQUEST_TEMPLATE/update_ci.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
name: Update CI
33
about: Create a pull request to update the CI/CD configuration
4-
title: "[CI] "
5-
labels: 'type: ci, status: in-progress'
6-
assignees: ''
7-
4+
title: "[ci] "
5+
labels: "type: ci, status: in-progress"
6+
assignees: ""
87
---
98

109
This pull request is to propose a CI/CD update for the `mc` project.

‎.github/PULL_REQUEST_TEMPLATE/update_docs.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
name: Update Docs
33
about: Create a pull request to update the documentation
4-
title: "[Docs] "
5-
labels: 'type: documentation, status: in-progress'
6-
assignees: ''
7-
4+
title: "[docs] "
5+
labels: "type: documentation, status: in-progress"
6+
assignees: ""
87
---
98

109
This pull request is to propose a documentation update for the `mc` project.

0 commit comments

Comments
 (0)