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

chore: update issue and pr templates #58

Merged
merged 1 commit into from
Oct 31, 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
11 changes: 5 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG] "
labels: 'type: bug, status: todo'
assignees: ''

name: Bug Report
about: Report a bug to help us improve
title: "[bug] "
labels: "type: bug"
assignees: ""
---

## Description
Expand Down
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/doc_issue.md
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.
9 changes: 4 additions & 5 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: Feature request
name: Feature Request
about: Suggest an idea for this project
title: "[Feature Request] "
labels: 'type: feature, status: todo'
assignees: ''

title: "[feature] "
labels: "type: feature"
assignees: ""
---

## Problem
Expand Down
33 changes: 14 additions & 19 deletions .github/ISSUE_TEMPLATE/release_discussion.md
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!
9 changes: 4 additions & 5 deletions .github/ISSUE_TEMPLATE/support_request.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: Support request
name: Support Request
about: Request support or ask a question
title: "[Support] "
labels: 'type: support, status: todo'
assignees: ''

title: "[support] "
labels: "type: support"
assignees: ""
---

## Question
Expand Down
7 changes: 3 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE/bug_fix.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: Bug Fix
about: Create a pull request for bug fix
title: "[Bug Fix] "
labels: 'type: bug, status: in-progress'
assignees: ''

title: "[bug fix] "
labels: "type: bug, status: in-progress"
assignees: ""
---

This pull request is to propose a bug fix for the `mc` project.
Expand Down
7 changes: 3 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE/new_feature.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: New Feature
about: Create a pull request for new feature
title: "[New Feature] "
labels: 'type: feature, status: in-progress'
assignees: ''

title: "[feature] "
labels: "type: feature, status: in-progress"
assignees: ""
---

This pull request is to propose the new feature of the `mc` project.
Expand Down
7 changes: 3 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE/new_release.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: New Release
about: Create a pull request for new release
title: "[Release] vX.X.X"
labels: 'type: release, status: in-progress'
assignees: ''

title: "[release] vX.X.X"
labels: "type: release, status: in-progress"
assignees: ""
---

## Overview
Expand Down
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/refactor_request.md
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.
7 changes: 3 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE/update_ci.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: Update CI
about: Create a pull request to update the CI/CD configuration
title: "[CI] "
labels: 'type: ci, status: in-progress'
assignees: ''

title: "[ci] "
labels: "type: ci, status: in-progress"
assignees: ""
---

This pull request is to propose a CI/CD update for the `mc` project.
Expand Down
7 changes: 3 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE/update_docs.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: Update Docs
about: Create a pull request to update the documentation
title: "[Docs] "
labels: 'type: documentation, status: in-progress'
assignees: ''

title: "[docs] "
labels: "type: documentation, status: in-progress"
assignees: ""
---

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