Revamp GitHub issue templates

Rename and update the existing bug report template to a Detailed Bug Report and simplify some prompts/checklists. Add new Quick Bug, Detailed Feature, and Quick Feature templates to distinguish quick vs. detailed submissions and apply appropriate labels (e.g., bug/quick, enhancement/detailed). Add ISSUE_TEMPLATE/config.yml to disable blank issues and provide a Discord contact link. Remove the old generic feature_request.yaml in favor of the new structured templates.
This commit is contained in:
NΞVΛR 2026-03-01 22:00:07 +01:00
parent 31752ba01e
commit b621c018ba
6 changed files with 140 additions and 77 deletions

View file

@ -1,22 +1,22 @@
name: "Bug Report"
description: "Report a bug to help us improve MinecraftConsoles"
title: "[Bug]: "
labels: ["bug"]
name: "Detailed Bug Report"
description: "Use this for complex bugs that require environment details and reproduction steps."
title: "[Detailed Bug]: "
labels: ["bug", "detailed"]
body:
- type: markdown
attributes:
value: |
**Thanks for taking the time to report a bug!**
Please ensure you are using the latest version of the repository and have followed the build instructions in the README.
**Thanks for taking the time to report a detailed bug!**
Please ensure you are using the latest version of the repository.
- type: checkboxes
id: checklist
attributes:
label: Pre-submission Checklist
description: "Please help us help you by checking these boxes. Reports missing this information may be closed."
description: "Please help us help you by checking these boxes."
options:
- label: "I have searched for existing issues and didn't find a similar one."
- label: "I have searched for existing issues."
required: true
- label: "I have followed the build instructions in the README exactly."
- label: "I have followed the build instructions in the README."
required: true
- label: "I am using the latest version of the `main` branch."
required: true
@ -32,8 +32,7 @@ body:
id: commit-hash
attributes:
label: Commit Hash / Version
description: "Provide the commit hash (e.g., `git rev-parse HEAD`) or version you are running."
placeholder: "e.g. 5a1b2c3d..."
description: "Provide the commit hash or version you are running."
validations:
required: false
- type: textarea
@ -44,13 +43,7 @@ body:
placeholder: |
1. Open MinecraftConsoles.sln
2. Set configuration to ...
3. Run the project
4. Do ...
or
1. Open the release or debug executable
2. Do ...
3. Do ...
validations:
required: true
- type: textarea
@ -85,14 +78,13 @@ body:
id: environment
attributes:
label: Environment Details
description: "e.g., Visual Studio version, Windows version, Hardware specs."
placeholder: "Visual Studio 2022 v17.x, Windows 11..."
description: "e.g., Visual Studio version, Windows version."
validations:
required: false
- type: textarea
id: context
attributes:
label: Visual Proof & Logs
description: "Drag and drop screenshots, videos, or log snippets here. Visual proof is highly recommended for game bugs."
description: "Drag and drop screenshots, videos, or logs."
validations:
required: false

View file

@ -0,0 +1,42 @@
name: "Quick Bug Report"
description: "Use this for small, obvious bugs (typos, UI glitches, etc.)"
title: "[Quick Bug]: "
labels: ["bug", "quick"]
body:
- type: markdown
attributes:
value: |
**Thanks for the quick report!**
Only use this for bugs that are simple to explain and don't require complex environment details.
- type: textarea
id: description
attributes:
label: Bug Description
description: "What's wrong?"
placeholder: "e.g., The 'Exit' button is misaligned in the pause menu."
validations:
required: true
- type: textarea
id: expected-actual
attributes:
label: Expected vs. Actual Behavior
description: "What should happen and what actually happens?"
validations:
required: true
- type: dropdown
id: build-config
attributes:
label: Build Configuration
options:
- Debug
- Release
- Both
validations:
required: true
- type: textarea
id: context
attributes:
label: Visual Proof / Extra info
description: "Screenshots are very helpful if it's a UI bug!"
validations:
required: false

View file

@ -0,0 +1,48 @@
name: "Detailed Feature Request"
description: "Use this for complex feature ideas that require detailed solutions and alternatives."
title: "[Detailed Feature]: "
labels: ["enhancement", "detailed"]
body:
- type: markdown
attributes:
value: |
**Thanks for your detailed feature proposal!**
We value deep dives into how we can improve MinecraftConsoles.
- type: checkboxes
id: checklist
attributes:
label: Pre-submission Checklist
description: "Please help us help you by checking these boxes."
options:
- label: "I have searched for existing feature requests."
required: true
- label: "I have read the README and understand the project goals."
required: true
- type: textarea
id: description
attributes:
label: Feature Description
description: "A clear and concise description of the feature you're interested in."
validations:
required: true
- type: textarea
id: solution
attributes:
label: Suggested Solution
description: "Describe the solution you'd like. What exactly should happen?"
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives
description: "Describe any alternative solutions or features you've considered."
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional Context
description: "Add any other context, mockups, or technical details here."
validations:
required: false

View file

@ -0,0 +1,32 @@
name: "Quick Feature Suggestion"
description: "Use this for small, simple ideas (minor QoL, small UI tweaks, etc.)"
title: "[Quick Suggestion]: "
labels: ["enhancement", "quick"]
body:
- type: markdown
attributes:
value: |
**Thanks for the suggestion!**
Use this for easy-to-explain improvements.
- type: textarea
id: description
attributes:
label: What's your idea?
description: "A short description of the improvement."
placeholder: "e.g., Add a toggle for X in the settings menu."
validations:
required: true
- type: textarea
id: why
attributes:
label: Why would this be useful?
description: "How does this improve the player experience?"
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional Context / Mockups
description: "Optional, but always helpful!"
validations:
required: false

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View file

@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Discord Server
url: https://discord.gg/5CSzhc9t
about: Join our Discord community for support and discussion.

View file

@ -1,56 +0,0 @@
---
name: Feature Request
description: Suggest an idea to help us improve MinecraftConsoles
title: "[Feature]: "
labels:
- "enhancement"
body:
- type: markdown
attributes:
value: |
**Thanks for taking the time to fill out this feature request report!**
We kindly ask that you search to see if an issue [already exists](https://github.com/smartcmd/MinecraftConsoles/issues) for your feature.
- type: checkboxes
id: checklist
attributes:
label: Pre-submission Checklist
description: "Please help us help you by checking these boxes. Feature requests missing this information may be closed."
options:
- label: "I have searched for existing feature requests and didn't find a similar one."
required: true
- label: "I have read the README and understand the project goals."
required: true
- type: textarea
attributes:
label: Description
description: |
A clear and concise description of the feature you're interested in.
validations:
required: true
- type: textarea
attributes:
label: Suggested Solution
description: |
Describe the solution you'd like. A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Alternatives
description: |
Describe alternatives you've considered.
A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
attributes:
label: Additional Context
description: |
Add any other context about the problem here.
validations:
required: false