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

optimize: github issue template #442

Merged
merged 5 commits into from
Sep 20, 2023
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
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug-report.en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ body:
- "server"
- "console"
- "plugin"
- "docs"
validations:
required: true

Expand Down
22 changes: 15 additions & 7 deletions .github/ISSUE_TEMPLATE/bug-report.zh.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ body:
有红色的 * 号,代表这项必填,没有则可不填。

- type: checkboxes
id: searchBeforeAsking
attributes:
label: Search before asking
label: 提问前查询
description: >
请去我们的 [issues](https://github.com/ikaros-dev/ikaros/issues?q=is%3Aissue) 列表里查询下,是否已经有类似的问题存在。
options:
Expand All @@ -21,30 +22,34 @@ body:
required: true

- type: dropdown
id: ikarosComponent
attributes:
label: Ikaros Component
label: 组件
description: |
请问是 Ikaros 哪个组件的问题 Ikaros 有很多子项目,请确认你选择的组件是对应这个BUG的组件。
multiple: false
options:
- "服务端 (server)"
- "控制台 (console)"
- "插件 (plugin)"
- "文档 (docs)"
validations:
required: true

- type: textarea
id: whatHappend
attributes:
label: What happened
label: 发生了什么
description: 描述下发生了什么
placeholder: >
请描述下发生了什么
validations:
required: true

- type: textarea
id: whatYouExpectedToHappen
attributes:
label: What you expected to happen
label: 预期是怎样
description: 你预期是什么样的行为(或动作),长日志格式 `<details><summary>x.log</summary> 很长的日志内容</details>`
placeholder: >
请解释下你为什么认为这个行为(或动作)是不符合预期的。并请您复制粘贴下 具体的错误日志或者UI截图
Expand All @@ -58,8 +63,9 @@ body:
required: true

- type: textarea
id: howToReproduce
attributes:
label: How to reproduce
label: 如何复现
description: >
这个问题如何去复现,如果您没法提供相对准确的复现步骤,请开个 [Discussion](https://github.com/li-guohao/ikaros/discussions)
placeholder: >
Expand All @@ -70,17 +76,19 @@ body:
required: true

- type: textarea
id: anythingElse
attributes:
label: Anything else
label: 其它补充内容
description: 其它的我们需要知道的补充内容,长日志格式 `<details><summary>x.log</summary> 很长的日志内容</details>`
placeholder: >
比如这个问题发生的频率? (一次? 多次? 经常发生)。

如果日志内容太长,可以用这个格式包裹起来:<details><summary>x.log</summary> 很长的日志内容</details>

- type: checkboxes
id: submitPullRequest
attributes:
label: Are you willing to submit PR?
label: 您将要去提交PR吗?
description: >
这个不是必须的,但是如果您知道这个问题如何修复,并且愿意提交RP给这个项目做贡献,我们将非常欢迎。
options:
Expand Down
20 changes: 13 additions & 7 deletions .github/ISSUE_TEMPLATE/feature-request.zh.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ body:
有红色的 * 号,代表这项必填,没有则可不填。

- type: checkboxes
id: searchBeforeAsking
attributes:
label: Search before asking
label: 创建前查询
description: >
请去我们的 [issues](https://github.com/ikaros-dev/ikaros/issues?q=is%3Aissue) 列表里查询下,是否已经有类似的问题存在。
options:
Expand All @@ -24,34 +25,39 @@ body:
required: true

- type: textarea
id: description
attributes:
label: Description
label: 描述
description: 您期望的新功能的描述

- type: textarea
id: useCase
attributes:
label: Use case
label: 使用案例
description: 你想要新功能有什么样的行为?
placeholder: >
这个新功能想要实现什么样的目标?对应实现思路有什么建议吗?

- type: textarea
id: relatedIssues
attributes:
label: Related issues
label: 相关的Issues
description: 目前是否有与此新功能有关的 issue, 您可以填写 `#数字` 或者URL 方便我们快速定位到这个issue

- type: checkboxes
id: submitPullRequest
attributes:
label: Are you willing to submit a PR?
label: 您想要提交PR吗?
description: >
这个不是必须的,但是如果您知道这个问题如何修复,并且原因提交RP给这个项目做贡献,我们将非常欢迎。
options:
- label: 是的我想要提交个PR!
required: false

- type: textarea
id: relatedPullRequests
attributes:
label: Related pull requests
label: 相关的PR
description: 目前是否有与此新功能有关的 pull request, 您可以填写 `#数字` 或者URL 方便我们快速定位到这个pr, 未完成的PR请在PR的title加上前缀`[WIP]`
placeholder: >
- [ ] 组件名1: PR链接
Expand All @@ -60,4 +66,4 @@ body:

- type: markdown
attributes:
value: "感谢您填写这个表单!因为有您的贡献,项目才能越来越好。"
value: "感谢您填写这个表单!因为有您的贡献,项目才能越来越好。"
Loading