You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hugegraph.apache.org by je...@apache.org on 2022/06/30 03:14:18 UTC
[incubator-hugegraph-toolchain] branch master updated: chore: Update issue template (#265)
This is an automated email from the ASF dual-hosted git repository.
jermy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-toolchain.git
The following commit(s) were added to refs/heads/master by this push:
new c016e85 chore: Update issue template (#265)
c016e85 is described below
commit c016e852da4ca8449e002a0b20e443a39c42acc7
Author: Simon Cheung <mi...@apache.org>
AuthorDate: Thu Jun 30 11:14:14 2022 +0800
chore: Update issue template (#265)
---
.github/ISSUE_TEMPLATE/bug_report.yml | 44 ++++++++++++++----------------
.github/ISSUE_TEMPLATE/config.yml | 6 ++--
.github/ISSUE_TEMPLATE/feature_request.yml | 44 ++++++++++++++++++++++++++++--
.github/ISSUE_TEMPLATE/question_ask.yml | 44 ++++++++++++++----------------
4 files changed, 84 insertions(+), 54 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 609b141..ec0b6e2 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -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:
@@ -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.apache.org/docs/clients/restful-api/) (http://localhost:8080/versions)
value: |
- Server Version: v0.12.x
- Loader Version: v0.12.x
@@ -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
@@ -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
@@ -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
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 94e67f7..165759e 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -4,11 +4,11 @@ blank_issues_enabled: false
contact_links:
- name: HugeGraph toolchain Doc
# TODO: update the url after repository rename
- url: https://hugegraph.github.io/hugegraph-doc
+ url: https://hugegraph.apache.org/docs/
about: Please search question here before opening a new issue
- name: HugeGraph Client Doc
- url: https://hugegraph.github.io/hugegraph-doc/quickstart/hugegraph-client.html
+ url: https://hugegraph.apache.org/docs/quickstart/hugegraph-client/
about: Please search question here before opening a new issue
- name: HugeGraph API Doc
- url: https://hugegraph.github.io/hugegraph-doc/clients/hugegraph-api.html
+ url: https://hugegraph.apache.org/docs/clients/restful-api/
about: Please search usage here before opening a new issue
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
index 4012606..318175c 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -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."
+
diff --git a/.github/ISSUE_TEMPLATE/question_ask.yml b/.github/ISSUE_TEMPLATE/question_ask.yml
index a13e685..c910caf 100644
--- a/.github/ISSUE_TEMPLATE/question_ask.yml
+++ b/.github/ISSUE_TEMPLATE/question_ask.yml
@@ -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 可能会被 **关闭**
- (更新时会再开启)
-
- type: dropdown
attributes:
label: Problem Type (问题类型)
@@ -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.apache.org/docs/clients/restful-api/) (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.apache.org/docs/clients/restful-api/), and [Server configuration documentation](https://hugegraph.apache.org/docs/config/config-option/) (if possible, please provide screenshots or GIF).
+ 图使用 / 配置相关问题，请优先参考 [REST-API 文档](https://hugegraph.apache.org/docs/clients/restful-api/), 以及 [Server 配置文档](https://hugegraph.apache.org/docs/config/config-option/) (请提供清晰的截图, 动图录屏更佳)
+ placeholder: |
type the main problem here
```java
@@ -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
@@ -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