feat: added new issue templates for documentation and question issues
This commit is contained in:
parent
67d7ccbf10
commit
100dbc8101
43
.github/ISSUE_TEMPLATE/#2_documentation.yml
vendored
43
.github/ISSUE_TEMPLATE/#2_documentation.yml
vendored
@ -1,43 +0,0 @@
|
|||||||
name: 📝 文档问题
|
|
||||||
description: 报告文档相关的问题
|
|
||||||
title: '[文档]: '
|
|
||||||
labels: ['documentation']
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
感谢您花时间来改进我们的文档!
|
|
||||||
|
|
||||||
- type: dropdown
|
|
||||||
id: type
|
|
||||||
attributes:
|
|
||||||
label: 文档问题类型
|
|
||||||
options:
|
|
||||||
- 缺失文档
|
|
||||||
- 不清晰的文档
|
|
||||||
- 不正确的文档
|
|
||||||
- 需要翻译
|
|
||||||
- 其他
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: input
|
|
||||||
id: location
|
|
||||||
attributes:
|
|
||||||
label: 文档位置
|
|
||||||
description: 您所指的文档在哪里?
|
|
||||||
placeholder: 例如 README.md, 贡献指南等
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: description
|
|
||||||
attributes:
|
|
||||||
label: 描述
|
|
||||||
description: 请描述文档存在的问题
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: suggestion
|
|
||||||
attributes:
|
|
||||||
label: 建议修改
|
|
||||||
description: 如果您有具体的建议来改进文档,请在此提供
|
|
||||||
44
.github/ISSUE_TEMPLATE/#2_question.yml
vendored
Normal file
44
.github/ISSUE_TEMPLATE/#2_question.yml
vendored
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
name: ❓ 提问
|
||||||
|
description: 提出一个问题或寻求帮助
|
||||||
|
title: '[问题]: '
|
||||||
|
labels: ['question']
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
感谢您的提问!请尽可能详细地描述您的问题,这样我们才能更好地帮助您。
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: question
|
||||||
|
attributes:
|
||||||
|
label: 您的问题
|
||||||
|
description: 请详细描述您的问题
|
||||||
|
placeholder: 请尽可能清楚地说明您的问题...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: context
|
||||||
|
attributes:
|
||||||
|
label: 相关背景
|
||||||
|
description: 请提供一些背景信息,帮助我们更好地理解您的问题
|
||||||
|
placeholder: 例如:使用场景、已尝试的解决方案等
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: additional
|
||||||
|
attributes:
|
||||||
|
label: 补充信息
|
||||||
|
description: 任何其他相关的信息、截图或代码示例
|
||||||
|
render: shell
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: priority
|
||||||
|
attributes:
|
||||||
|
label: 优先级
|
||||||
|
description: 这个问题对您来说有多紧急?
|
||||||
|
options:
|
||||||
|
- 低 (有空再看)
|
||||||
|
- 中 (希望尽快得到答复)
|
||||||
|
- 高 (阻碍工作进行)
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
43
.github/ISSUE_TEMPLATE/2_documentation.yml
vendored
43
.github/ISSUE_TEMPLATE/2_documentation.yml
vendored
@ -1,43 +0,0 @@
|
|||||||
name: 📝 Documentation Issue
|
|
||||||
description: Report issues with documentation
|
|
||||||
title: '[Docs]: '
|
|
||||||
labels: ['documentation']
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Thanks for taking the time to improve our documentation!
|
|
||||||
|
|
||||||
- type: dropdown
|
|
||||||
id: type
|
|
||||||
attributes:
|
|
||||||
label: Type of documentation issue
|
|
||||||
options:
|
|
||||||
- Missing documentation
|
|
||||||
- Unclear documentation
|
|
||||||
- Incorrect documentation
|
|
||||||
- Translation needed
|
|
||||||
- Other
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: input
|
|
||||||
id: location
|
|
||||||
attributes:
|
|
||||||
label: Documentation Location
|
|
||||||
description: Where is the documentation you're referring to?
|
|
||||||
placeholder: e.g. README.md, Contributing Guide, etc.
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: description
|
|
||||||
attributes:
|
|
||||||
label: Description
|
|
||||||
description: Please describe the issue with the documentation
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
id: suggestion
|
|
||||||
attributes:
|
|
||||||
label: Suggested Changes
|
|
||||||
description: If you have specific suggestions for how to improve the documentation, please provide them here
|
|
||||||
44
.github/ISSUE_TEMPLATE/2_question.yml
vendored
Normal file
44
.github/ISSUE_TEMPLATE/2_question.yml
vendored
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
name: ❓ Question
|
||||||
|
description: Ask a question or seek help
|
||||||
|
title: '[Question]: '
|
||||||
|
labels: ['question']
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Thanks for asking a question! Please provide as much detail as possible so we can better assist you.
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: question
|
||||||
|
attributes:
|
||||||
|
label: Your Question
|
||||||
|
description: Please describe your question in detail
|
||||||
|
placeholder: Please explain your question as clearly as possible...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: context
|
||||||
|
attributes:
|
||||||
|
label: Context
|
||||||
|
description: Please provide some background information to help us better understand your question
|
||||||
|
placeholder: "For example: use case, solutions you've tried, etc."
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: additional
|
||||||
|
attributes:
|
||||||
|
label: Additional Information
|
||||||
|
description: Any other relevant information, screenshots, or code examples
|
||||||
|
render: shell
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: priority
|
||||||
|
attributes:
|
||||||
|
label: Priority
|
||||||
|
description: How urgent is this question for you?
|
||||||
|
options:
|
||||||
|
- Low (Can wait)
|
||||||
|
- Medium (Would like a response soon)
|
||||||
|
- High (Blocking progress)
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
Loading…
x
Reference in New Issue
Block a user