Updated GitHub issue templates for Bug Report, Help Request, and Translation Request

- Bug Report template with detailed reproduction steps, logs, and checklist
- Ask for Help template to guide users in submitting clear questions
- Translation Request template to facilitate multilingual contributions
This commit is contained in:
Tola Leng
2025-07-23 22:55:04 +07:00
parent fda91aedb9
commit 2bc508a230
4 changed files with 31 additions and 36 deletions
+14 -15
View File
@@ -9,16 +9,16 @@ body:
attributes: attributes:
value: | value: |
**Thank you for taking the time to report a bug!** **Thank you for taking the time to report a bug!**
Please fill out the following template so we can reproduce and fix the issue faster. Please complete the form below to help us reproduce and fix the issue more effectively.
- type: input - type: input
id: environment id: environment
attributes: attributes:
label: Environment label: Environment
description: | description: |
Describe where you encountered the issue. Describe the environment where the issue occurred.
(e.g., OS, browser, Node version, etc.) (e.g., OS, browser, Node.js version, Docker version, etc.)
placeholder: "Example: macOS 14.0, Chrome 125, Node.js 20.3.0" placeholder: "Example: Ubuntu 22.04, Chrome 125, Node.js 20.3.0"
validations: validations:
required: true required: true
@@ -27,7 +27,7 @@ body:
attributes: attributes:
label: Bug Description label: Bug Description
description: | description: |
A clear and concise description of what the bug is. A clear and concise description of the issue you encountered.
placeholder: "When I do X, Y happens instead of Z..." placeholder: "When I do X, Y happens instead of Z..."
validations: validations:
required: true required: true
@@ -37,13 +37,12 @@ body:
attributes: attributes:
label: Steps to Reproduce label: Steps to Reproduce
description: | description: |
How can we reproduce the behavior? Provide step-by-step instructions to reproduce the issue.
Please list the steps in order.
placeholder: | placeholder: |
1. Go to '...' 1. Go to '...'
2. Click on '...' 2. Click on '...'
3. Scroll down to '...' 3. Scroll down to '...'
4. See error 4. See the error
validations: validations:
required: true required: true
@@ -61,8 +60,8 @@ body:
attributes: attributes:
label: Screenshots or Videos label: Screenshots or Videos
description: | description: |
If applicable, add screenshots or screen recordings to help explain your problem. If applicable, add screenshots or screen recordings to help illustrate the issue.
placeholder: "Attach screenshots here." placeholder: "Drag and drop or paste screenshots here."
validations: validations:
required: false required: false
@@ -71,8 +70,8 @@ body:
attributes: attributes:
label: Logs label: Logs
description: | description: |
If applicable, paste logs or error messages here. If applicable, paste any relevant logs or error messages.
Please remove any sensitive information. Please remove sensitive information before submitting.
render: shell render: shell
placeholder: | placeholder: |
``` ```
@@ -86,9 +85,9 @@ body:
id: terms id: terms
attributes: attributes:
label: Checklist label: Checklist
description: Before submitting, please confirm: description: Please confirm the following before submitting:
options: options:
- label: I have searched existing issues to avoid duplicates. - label: I have searched existing issues to avoid creating duplicates.
required: true required: true
- label: I have provided enough information for reproduction. - label: I have provided sufficient information to reproduce the issue.
required: true required: true
+1 -1
View File
@@ -1 +1 @@
blank_issues_enabled: false blank_issues_enabled: true
+4 -8
View File
@@ -15,8 +15,7 @@ body:
id: description id: description
attributes: attributes:
label: Feature Description label: Feature Description
description: | description: A clear and concise description of the feature youd like to see.
A clear and concise description of the feature youd like to see.
placeholder: "I would like to have..." placeholder: "I would like to have..."
validations: validations:
required: true required: true
@@ -25,8 +24,7 @@ body:
id: motivation id: motivation
attributes: attributes:
label: Motivation label: Motivation
description: | description: Please explain why this feature would be useful.
Please explain why this feature would be useful.
placeholder: "This feature would help because..." placeholder: "This feature would help because..."
validations: validations:
required: true required: true
@@ -35,8 +33,7 @@ body:
id: alternatives id: alternatives
attributes: attributes:
label: Alternatives Considered label: Alternatives Considered
description: | description: Have you considered any alternative solutions or workarounds?
Have you considered any alternative solutions or workarounds?
placeholder: "I have tried..." placeholder: "I have tried..."
validations: validations:
required: false required: false
@@ -45,8 +42,7 @@ body:
id: additional id: additional
attributes: attributes:
label: Additional Context label: Additional Context
description: | description: Add any other context or screenshots about the feature request here.
Add any other context or screenshots about the feature request here.
placeholder: "Links to related issues or references..." placeholder: "Links to related issues or references..."
validations: validations:
required: false required: false
@@ -1,5 +1,5 @@
name: ❓ Ask for Help name: ❓ Ask for Help
description: Ask a question or request guidance about this project. description: Ask a question or request guidance related to this project.
title: "[Question]: " title: "[Question]: "
labels: [question] labels: [question]
assignees: [] assignees: []
@@ -8,8 +8,8 @@ body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
**Thank you for reaching out!** **Thanks for reaching out!**
Please fill out this form to help us understand your question. Please provide as much detail as possible so we can better assist you.
- type: textarea - type: textarea
id: question id: question
@@ -17,17 +17,17 @@ body:
label: What do you need help with? label: What do you need help with?
description: Clearly describe your question or what you're trying to achieve. description: Clearly describe your question or what you're trying to achieve.
placeholder: | placeholder: |
I am trying to do X but I'm not sure how to... I am trying to do X, but I'm not sure how to...
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: context id: context
attributes: attributes:
label: Context label: Additional Context
description: | description: |
Provide any additional context, related issues, or links that help explain your question. Provide any relevant context, related issues, pull requests, or documentation links that could help us understand your question better.
placeholder: "Related issues, pull requests, or documentation..." placeholder: "Mention related issues, links to docs, or previous discussions..."
validations: validations:
required: false required: false
@@ -36,8 +36,8 @@ body:
attributes: attributes:
label: Environment Details label: Environment Details
description: | description: |
If applicable, please provide details about your environment (OS, Node version, browser, etc.). If relevant, provide details about your environment (e.g., OS, browser, Node.js version).
placeholder: "Example: Ubuntu 22.04, Node.js v20, Chrome 125" placeholder: "Example: Windows 11, Node.js v20.3.0, Firefox 125"
validations: validations:
required: false required: false
@@ -45,9 +45,9 @@ body:
id: checklist id: checklist
attributes: attributes:
label: Checklist label: Checklist
description: Before submitting, please confirm: description: Before submitting, please confirm the following:
options: options:
- label: I have searched existing issues and discussions. - label: I have searched existing issues and discussions for a solution.
required: true required: true
- label: I have read the documentation. - label: I have read the relevant documentation.
required: true required: true