feat: add issue templates for bug reports, documentation updates, feature requests, and questions

This commit is contained in:
ciat-777
2026-03-15 13:30:55 +08:00
parent 4aff5e6e27
commit 723fee99bf
8 changed files with 484 additions and 0 deletions
+80
View File
@@ -0,0 +1,80 @@
name: Bug report
description: Report a reproducible problem in Metapi
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting a bug. Please include enough detail for someone else to reproduce it.
- type: checkboxes
id: checks
attributes:
label: Before submitting
options:
- label: I searched existing issues to avoid creating a duplicate
required: true
- label: I tested on the latest release or current main branch
required: true
- type: dropdown
id: deployment
attributes:
label: Deployment type
description: Where did you reproduce the problem?
options:
- Web app
- Desktop app
- Server only
- Docker deployment
- Other
validations:
required: true
- type: textarea
id: summary
attributes:
label: What happened?
description: Describe the bug clearly and concisely.
placeholder: Describe the problem you observed.
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce
placeholder: |
1. Go to ...
2. Configure ...
3. Send request ...
4. Observe ...
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
placeholder: Describe what you expected to happen.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Logs, screenshots, or error output
description: Paste logs or attach screenshots if available.
render: shell
- type: textarea
id: environment
attributes:
label: Environment
description: Include OS, browser, app version, database type, or other relevant details.
placeholder: |
OS:
Browser:
Metapi version:
Database:
+5
View File
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Metapi README
url: https://github.com/cita-777/metapi#readme
about: Start with the README for setup, usage, and deployment details.
+40
View File
@@ -0,0 +1,40 @@
name: Documentation update
description: Report missing, incorrect, or unclear documentation
title: "[Docs]: "
labels: ["docs"]
body:
- type: markdown
attributes:
value: |
Use this template when documentation is missing, incorrect, or hard to follow.
- type: checkboxes
id: checks
attributes:
label: Before submitting
options:
- label: I searched existing issues to avoid creating a duplicate
required: true
- type: input
id: location
attributes:
label: Documentation location
description: Link the page or file that needs attention.
placeholder: e.g. README.md or docs/getting-started.md
validations:
required: true
- type: textarea
id: issue
attributes:
label: What is wrong or missing?
placeholder: Describe the missing, inaccurate, or confusing part.
validations:
required: true
- type: textarea
id: fix
attributes:
label: Suggested improvement
placeholder: Describe how the documentation could be improved.
@@ -0,0 +1,49 @@
name: Feature request
description: Suggest a new capability or improvement
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for the suggestion. Keep this issue focused on one feature request.
- type: checkboxes
id: checks
attributes:
label: Before submitting
options:
- label: I searched existing issues to avoid creating a duplicate
required: true
- label: I confirmed this feature is not already available in the latest release or main branch
required: true
- type: textarea
id: problem
attributes:
label: Problem or use case
description: What problem are you trying to solve?
placeholder: Explain the workflow or pain point behind this request.
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed solution
description: Describe the change you want to see.
placeholder: Explain the feature or behavior you want added.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Describe any workaround or alternative you considered.
- type: textarea
id: context
attributes:
label: Additional context
description: Add screenshots, examples, or links if they help explain the request.
+39
View File
@@ -0,0 +1,39 @@
name: Question
description: Ask for clarification or usage guidance
title: "[Question]: "
labels: ["question"]
body:
- type: markdown
attributes:
value: |
Use this template for support or clarification questions that are not bug reports or feature requests.
- type: checkboxes
id: checks
attributes:
label: Before submitting
options:
- label: I searched existing issues and the README for an answer
required: true
- type: textarea
id: question
attributes:
label: Question
description: What do you need help understanding?
placeholder: Ask one clear question and include the relevant context.
validations:
required: true
- type: textarea
id: tried
attributes:
label: What have you tried?
description: Include commands, config, or investigation you already attempted.
- type: textarea
id: environment
attributes:
label: Relevant environment or config
description: Paste config snippets, request examples, or environment details if needed.
render: shell