This is an automated email from the ASF dual-hosted git repository. ming pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-ai.git
commit 49732286ccce88148fde08a87316b7141f07bc75 Author: simon <[email protected]> AuthorDate: Mon Oct 9 16:34:17 2023 +0800 init asf.yaml --- .github/ISSUE_TEMPLATE/bug_report.yml | 95 +++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 18 ++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 53 +++++++++++++++++ .github/ISSUE_TEMPLATE/question_ask.yml | 96 ++++++++++++++++++++++++++++++ 4 files changed, 262 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..d3229f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,95 @@ +name: Bug report +description: Create a bug report to help HugeGraph improve +title: '[Bug] describe the main problem' +labels: + - bug + +body: + - type: markdown + attributes: + 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: + label: Bug Type (问题类型) + options: + - gremlin (结果不合预期) + - rest-api (结果不合预期) + - dashboard render (前端渲染问题) + - data inconsistency (数据不一致) + - exception / error (异常报错) + - others (please comment below) + + - type: checkboxes + attributes: + label: Before submit + options: + - label: I had searched in the [issues](https://github.com/apache/hugegraph-toolchain/issues) and found no similar issues. + required: true + + - type: textarea + attributes: + label: Environment (环境信息) + description: > + server version could get from [rest-api](https://hugegraph.apache.org/docs/clients/restful-api/) (http://localhost:8080/versions) + value: | + - Server Version: v1.x.x + - Toolchain Version: v1.x.x + - Data Size: xx vertices, xx edges <!-- (like 1000W 点, 9000W 边) --> + validations: + required: true + + - type: textarea + 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. + 可以参考 [如何提供最简的可复现用例](https://stackoverflow.com/help/minimal-reproducible-example)，请提供清晰的截图, 动图录屏更佳。 + placeholder: | + type the main problem here + + ```java + // Detailed exception / error info (尽可能详细的日志 + 完整异常栈) + + ``` + validations: + required: true + + - type: textarea + attributes: + label: Vertex/Edge example (问题点 / 边数据举例) + description: | + 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 + + // JSON of Vertex / Edge + { + "vertex": { "id": "xxx" } + } + render: javascript + + - type: textarea + attributes: + label: Schema [VertexLabel, EdgeLabel, IndexLabel] (元数据结构) + description: | + 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 + + // JSON of GraphSchema + { + "vertex": { "id": "xxx" } + } + render: javascript diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..1617270 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,18 @@ +blank_issues_enabled: false + +contact_links: + - name: HugeGraph Loader Doc + url: https://hugegraph.apache.org/docs/quickstart/hugegraph-loader/ + about: Please search question here before opening a new issue + - name: HugeGraph Hubble Doc + url: https://hugegraph.apache.org/docs/quickstart/hugegraph-hubble/ + about: Please search usage here before opening a new issue + - name: HugeGraph Tools Doc + url: https://hugegraph.apache.org/docs/quickstart/hugegraph-tools/ + about: Please search question here before opening a new issue + - name: HugeGraph Client Doc + 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.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 new file mode 100644 index 0000000..318175c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,53 @@ +name: Feature request (新需求 / 功能) +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: > + 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 new file mode 100644 index 0000000..452c7dd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question_ask.yml @@ -0,0 +1,96 @@ +name: Ask question (提问) +description: Question about usage or configs in HugeGraph +title: '[Question] describe your problem' + +body: + - type: markdown + attributes: + 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: + label: Problem Type (问题类型) + options: + - gremlin (结果不合预期) + - rest-api (结果不合预期) + - logic (逻辑设计问题) + - performance (性能问题) + - dashboard render (前端渲染问题) + - data inconsistency (数据不一致) + - configs (配置项 / 文档相关) + - exception / error (异常报错) + - others (please comment below) + + - type: checkboxes + attributes: + label: Before submit + options: + - label: I had searched in the [issues](https://github.com/apache/hugegraph-toolchain/issues) and found no similar issues. + required: true + + - type: textarea + attributes: + label: Environment (环境信息) + description: | + server version could get from [rest-api](https://hugegraph.apache.org/docs/clients/restful-api/) (http://localhost:8080/versions) + value: | + - Server Version: 1.x.x + - Toolchain Version: 1.x.x + - Data Size: xx vertices, xx edges <!-- (like 1000W 点, 9000W 边) --> + validations: + required: true + + - type: textarea + attributes: + label: Your Question (问题描述) + description: | + 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 + // Exception / Error info (尽可能详细的日志 + 完整异常栈) + + ``` + validations: + required: true + + - type: textarea + attributes: + label: Vertex/Edge example (问题点 / 边数据举例) + description: | + 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 + + // JSON of Vertex / Edge + { + "vertex": { "id": "xxx" } + } + render: javascript + + - type: textarea + attributes: + label: Schema [VertexLabel, EdgeLabel, IndexLabel] (元数据结构) + description: | + 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 + + // JSON of GraphSchema + { + "vertex": { "id": "xxx" } + } + render: javascript
