-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update issue and pr templates (#58)
- Loading branch information
Showing
11 changed files
with
89 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Documentation Issue | ||
about: Report an issue or suggest an improvement for the project documentation or its display on the site | ||
title: "[docs] " | ||
labels: "type: documentation" | ||
assignees: "" | ||
--- | ||
|
||
## Issue Type | ||
|
||
Specify whether the issue is related to the document content or its display on the site. | ||
|
||
- [ ] Document Content | ||
- [ ] Site Display | ||
|
||
## Location | ||
|
||
Specify the document or section where the issue is found. Provide links if possible. | ||
|
||
- [link to the document] | ||
|
||
## Description | ||
|
||
A clear and concise description of what the issue is. Include any relevant details or context. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,33 @@ | ||
--- | ||
name: New release discussion | ||
name: New Release Discussion | ||
about: Create a discussion issue for new release | ||
title: "[Discussion] vX.X.X Release Planning 🚀" | ||
labels: 'type: release, type: discussion, status: in-progress, good first issue' | ||
assignees: '' | ||
|
||
title: "[discussion] vX.X.X Release Planning 🚀" | ||
labels: "type: release, type: discussion, status: in-progress, good first issue" | ||
assignees: "" | ||
--- | ||
|
||
## Overview | ||
|
||
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. | ||
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. | ||
|
||
## Proposed Features | ||
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. | ||
|
||
Please list any features you would like to propose for inclusion in this release. Include a brief description. | ||
## Candidates | ||
|
||
``` | ||
## [Add/Update/Remove] feature(s) | ||
- [link to feature request issue] or [short description] | ||
``` | ||
### Feature | ||
|
||
## Bug Fixes | ||
- [link to feature request issue] or [short description] | ||
|
||
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. | ||
### Bug Fix | ||
|
||
``` | ||
## Fix bug(s) | ||
- [link to bug report issue] or [short description] | ||
``` | ||
|
||
### Chore | ||
|
||
- [link to chore issue] or [short description] | ||
|
||
## Follow-Up | ||
|
||
We will regularly follow up on this discussion to track progress and ensure that all proposed items are addressed before the release. | ||
|
||
--- | ||
|
||
Thank you for your contributions! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: Refactor Request | ||
about: Suggest a code refactor | ||
title: "[refactor] " | ||
labels: "type: refactor" | ||
assignees: "" | ||
--- | ||
|
||
## Current Code | ||
|
||
Describe the current code that needs refactoring. | ||
|
||
## Suggested Refactor | ||
|
||
Describe the proposed changes and improvements. | ||
|
||
## Benefits | ||
|
||
Explain the benefits of the refactor, such as improved readability or performance. | ||
|
||
## Additional context | ||
|
||
Add any other context or screenshots about the refactor request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters