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

chore: Update issue template #265

Merged
merged 4 commits into from
Jun 30, 2022
Merged
Show file tree
Hide file tree
Changes from 3 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
44 changes: 20 additions & 24 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,14 @@ labels:
body:
- type: markdown
attributes:
value: >-
### Note (特别注意) :

> 1. 请先**搜索**现有的[Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与
[Toolchain-Issues](https://github.com/hugegraph/hugegraph-loader/issues) 中没有与您相同
/ 相关的问题 (请勿重复提交)

> 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等)
会**越快**被响应和处理

> 3. Issue 标题请保持原有模板分类(例如:`[Bug]`), 长段描述之间可以增加`空行`或使用`序号`标记, 保持排版清晰

> 4. 请在对应的模块提交 issue, 缺乏有效信息 / 长时间 (> 14 天) 没有回复的 issue 可能会被 **关闭**
(更新时会再开启)
value: |
**Note (特别注意)**:
1. We need as much detailed information as possible to reproduce the problem, the more detailed information (including logs/screenshots/configurations, etc.) will be responded and processed faster.
我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等)会**越快**被响应和处理。
2. Please keep the original template category (for example: [Bug]) for the Issue title. You can add blank lines or use serial numbers between long descriptions to keep the typesetting clear.
Issue 标题请保持原有模板分类(例如:`[Bug]`), 长段描述之间可以增加`空行`或使用`序号`标记, 保持排版清晰。
3. Please submit an issue in the corresponding module, lack of valid information / long time (>14 days) unanswered issues may be closed (will be reopened when updated).
请在对应的模块提交 issue, 缺乏有效信息 / 长时间 (> 14 天) 没有回复的 issue 可能会被 **关闭**(更新时会再开启)。

- type: dropdown
attributes:
Expand All @@ -37,14 +31,14 @@ body:
attributes:
label: Before submit
options:
- label: 我已经确认现有的 [Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与 [Toolchain-Issues](https://github.com/hugegraph/hugegraph-loader/issues) 中没有相同 / 重复问题
- label: I had searched in the [issues](https://github.com/hugegraph/hugegraph-loader/issues) and found no similar issues.
required: true

- type: textarea
attributes:
label: Environment (环境信息)
description: |
> server version could get from [rest-api](https://hugegraph.github.io/hugegraph-doc/clients/restful-api/other.html) (http://localhost:8080/versions)
description: >
server version could get from [rest-api](https://hugegraph.github.io/hugegraph-doc/clients/restful-api/other.html) (http://localhost:8080/versions)
value: |
- Server Version: v0.12.x
- Loader Version: v0.12.x
Expand All @@ -56,9 +50,9 @@ body:
attributes:
label: Expected & Actual behavior (期望与实际表现)
description: |
> we can refer [How to create a minimal reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example) (如何提供最简的可复现用例)
> if possible, please provide screenshots or GIF (请提供清晰的截图, 动图录屏更佳)
placeholder: |
we can refer [How to create a minimal reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example), if possible, please provide screenshots or GIF.
可以参考 [如何提供最简的可复现用例](https://stackoverflow.com/help/minimal-reproducible-example),请提供清晰的截图, 动图录屏更佳
placeholder: |
type the main problem here

```java
Expand All @@ -67,12 +61,13 @@ body:
```
validations:
required: true

- type: textarea
attributes:
label: Vertex/Edge example (问题点 / 边数据举例)
description: |
> 如果问题与具体的点 / 边数据相关, 请提供完整的`原始数据 + REST-API 查询结果`
If the question is related to specific point/edge data, please provide the full `raw data REST-API query result`.
(如果问题与具体的点 / 边数据相关, 请提供完整的`原始数据 + REST-API 查询结果`)
placeholder: |
// Origin data
tom 18 boy HK
Expand All @@ -82,12 +77,13 @@ body:
"vertex": { "id": "xxx" }
}
render: javascript

- type: textarea
attributes:
label: Schema [VertexLabel, EdgeLabel, IndexLabel] (元数据结构)
description: |
> 如果问题与具体的点类型 / 边类型 / 索引类型相关, 请提供完整的 `Schema 返回 JSON 结果`
If the problem is related to a specific point type/edge type/index type, please provide the full Schema.
(如果问题与具体的点类型 / 边类型 / 索引类型相关, 请提供完整的 `Schema 返回 JSON 结果`)
placeholder: |
// Query URL
GET http://localhost:8080/graphs/hugegraph/schema/vertexlabels
Expand Down
44 changes: 41 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,53 @@
name: Feature request (新需求 / 功能)
description: Give an idea for HugeGraph
description: Give an idea for hugegraph-toolchain
title: '[Feature] describe the new feature'
labels:
- feature

body:
- type: checkboxes
attributes:
label: Search before asking
description: >
Please make sure to search in the [feature](https://github.com/apache/incubator-hugegraph-toolchain/issues?q=is%3Aissue+label%3A%22Feature%22) first
to see whether the same feature was requested already.
options:
- label: >
I had searched in the [feature](https://github.com/apache/incubator-hugegraph-toolchain/issues?q=is%3Aissue+label%3A%22Feature%22) and found no
similar feature requirement.
required: true

- type: textarea
attributes:
label: Feature Description (功能描述)
description: |
> 请简要描述新功能 / 需求的使用场景或上下文, 最好能给个具体的例子说明
description: >
Please describe the function you want in as much detail as possible. (请简要描述新功能 /
需求的使用场景或上下文, 最好能给个具体的例子说明)
placeholder: type the feature description here
validations:
required: true

- type: checkboxes
attributes:
label: Are you willing to submit a PR?
description: >
This is absolutely not required, but we are happy to guide you in the contribution process
especially if you already have a good understanding of how to implement the feature.
hugegraph-toolchain is a totally community-driven project and we love to bring new contributors in.
options:
- label: Yes I am willing to submit a PR!

- type: checkboxes
attributes:
label: Code of Conduct
description: |
The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it.
options:
- label: |
I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
required: true

- type: markdown
attributes:
value: "Thanks for completing our form, and we will reply you as soon as possible."

44 changes: 20 additions & 24 deletions .github/ISSUE_TEMPLATE/question_ask.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,15 @@ title: '[Question] describe your problem'
body:
- type: markdown
attributes:
value: >-
### Note (特别注意) :

> 1. 请先**搜索**现有的[Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与
[Toolchain-Issues](https://github.com/hugegraph/hugegraph-loader/issues) 中没有与您相同
/ 相关的问题 (请勿重复提交)

> 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等)
会**越快**被响应和处理

> 3. Issue 标题请保持原有模板分类(例如:`[Bug]`), 长段描述之间可以增加`空行`或使用`序号`标记, 保持排版清晰
value: |
**Note (特别注意)**:
1. We need as much detailed information as possible to reproduce the problem, the more detailed information (including logs/screenshots/configurations, etc.) will be responded and processed faster.
我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等)会**越快**被响应和处理。
2. Please keep the original template category (for example: [Bug]) for the Issue title. You can add blank lines or use serial numbers between long descriptions to keep the typesetting clear.
Issue 标题请保持原有模板分类(例如:`[Bug]`), 长段描述之间可以增加`空行`或使用`序号`标记, 保持排版清晰。
3. Please submit an issue in the corresponding module, lack of valid information / long time (>14 days) unanswered issues may be closed (will be reopened when updated).
请在对应的模块提交 issue, 缺乏有效信息 / 长时间 (> 14 天) 没有回复的 issue 可能会被 **关闭**(更新时会再开启)。

> 4. 请在对应的模块提交 issue, 缺乏有效信息 / 长时间 (> 14 天) 没有回复的 issue 可能会被 **关闭**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here we could give 2 language version, or keep only EN one

(更新时会再开启)

- type: dropdown
attributes:
label: Problem Type (问题类型)
Expand All @@ -38,28 +32,28 @@ body:
attributes:
label: Before submit
options:
- label: 我已经确认现有的 [Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与 [Toolchain-Issues](https://github.com/hugegraph/hugegraph-loader/issues) 中没有相同 / 重复问题
- label: I had searched in the [issues](https://github.com/hugegraph/hugegraph-loader/issues) and found no similar issues.
required: true

- type: textarea
attributes:
label: Environment (环境信息)
description: |
> server version could get from [rest-api](https://hugegraph.github.io/hugegraph-doc/clients/restful-api/other.html) (http://localhost:8080/versions)
server version could get from [rest-api](https://hugegraph.github.io/hugegraph-doc/clients/restful-api/other.html) (http://localhost:8080/versions)
value: |
- Server Version: v0.12.x
- Loader Version: v0.12.x
- Data Size: xx vertices, xx edges <!-- (like 1000W 点, 9000W 边) -->
validations:
required: true

- type: textarea
attributes:
label: Your Question (问题描述)
description: |
> 图使用 / 配置相关问题,请优先参考 [REST-API 文档](https://hugegraph.github.io/hugegraph-doc/clients/hugegraph-api.html), 以及 [Server 配置文档](https://hugegraph.github.io/hugegraph-doc/config/config-option.html)
> if possible, please provide screenshots or GIF (请提供清晰的截图, 动图录屏更佳)
placeholder: |
For issues related to graph usage/configuration, please refer to [REST-API documentation](https://hugegraph.github.io/hugegraph-doc/clients/hugegraph-api.html), and [Server configuration documentation](https:/ /hugegraph.github.io/hugegraph-doc/config/config-option.html) (if possible, please provide screenshots or GIF).
图使用 / 配置相关问题,请优先参考 [REST-API 文档](https://hugegraph.github.io/hugegraph-doc/clients/hugegraph-api.html), 以及 [Server 配置文档](https://hugegraph.github.io/hugegraph-doc/config/config-option.html) (请提供清晰的截图, 动图录屏更佳)
simon824 marked this conversation as resolved.
Show resolved Hide resolved
placeholder: |
type the main problem here

```java
Expand All @@ -68,12 +62,13 @@ body:
```
validations:
required: true

- type: textarea
attributes:
label: Vertex/Edge example (问题点 / 边数据举例)
description: |
> 如果问题与具体的点 / 边数据相关, 请提供完整的`原始数据 + REST-API 查询结果`
If the question is related to specific point/edge data, please provide the full `raw data REST-API query result`.
(如果问题与具体的点 / 边数据相关, 请提供完整的`原始数据 + REST-API 查询结果`)
placeholder: |
// Origin data
tom 18 boy HK
Expand All @@ -83,12 +78,13 @@ body:
"vertex": { "id": "xxx" }
}
render: javascript

- type: textarea
attributes:
label: Schema [VertexLabel, EdgeLabel, IndexLabel] (元数据结构)
description: |
> 如果问题与具体的点类型 / 边类型 / 索引类型相关, 请提供完整的 `Schema 返回 JSON 结果`
If the problem is related to a specific point type/edge type/index type, please provide the full Schema.
(如果问题与具体的点类型 / 边类型 / 索引类型相关, 请提供完整的 `Schema 返回 JSON 结果`)
placeholder: |
// Query URL
GET http://localhost:8080/graphs/hugegraph/schema/vertexlabels
Expand Down