From acb7eb148a52dc3b2945859a9cb978bb5bdd9ee5 Mon Sep 17 00:00:00 2001 From: imbajin Date: Thu, 20 May 2021 16:45:34 +0800 Subject: [PATCH] doc: use 3 issue template for better community experience (#1453) use 3 issue template for better efficiency At present, there are 3 issue template and 1 config file: - Bug Report - Feature Request - Ask question (Guide) And simplify the issue template to improve the user's willingness to fill in --- .github/ISSUE_TEMPLATE/bug_report.md | 55 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 10 +++++ .github/ISSUE_TEMPLATE/feature_request.md | 11 +++++ .github/ISSUE_TEMPLATE/question_ask.md | 46 +++++++++++++++++++ issue_template.md | 32 ------------- 5 files changed, 122 insertions(+), 32 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question_ask.md delete mode 100644 issue_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..5d882c4dfb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,55 @@ +--- +name: Bug report (反馈 Bug) +about: Create a bug report to help HugeGraph improve +title: '[Bug] Briefly describe the main problem here' +labels: 'bug' +assignees: '' + +--- + +### Note ( 特别注意 ) : + +> 1. 请先**搜索**, 并**确认**现有的 [Issues](https://github.com/hugegraph/hugegraph/issues) 与 [FAQ](https://hugegraph.github.io/hugegraph-doc/guides/faq.html) 中没有与您相同 / 相关的问题, 请勿重复提交 +> 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等) 会**越快**被响应和处理 +> 3. 请关注提交的 issue, 缺乏信息 / 长时间 ( > 14 天) 没有回复, issue 可能会被 **关闭** (需要时可再开启) + + +## Environment ( 环境信息 - 必填 ) +- **Server Version**: v0.11.x (refer [here](https://hugegraph.github.io/hugegraph-doc/clients/restful-api/other.html)) +- **Backend**: Cassandra 3.x, x nodes, HDD or SSD +- **OS**: xx CPUs, xx G RAM, Centos 7.x +- **Data Size**: xx vertices, xx edges (like 1000W 点, 9000W 边) + +## Expected behavior ( 期望表现 ) + +xxx + +## Actual behavior ( 实际表现 / 报错) + +xxx + +```java +// Error info ⬇ (尽可能详细的日志 + 完整异常栈) + +``` + +## How to reproduce ( 复现步骤 ) +1. step 1 +2. step 2 +3. step 3 + +**Refer:** [How to create a minimal reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example) + +### Vertex/Edge example ( 问题点 / 边数据举例 ) + +```javascript +// JSON of Vertex / Edge ⬇ + +``` + +### Schema [VertexLabel, EdgeLabel, IndexLabel] ( 元数据结构 ) + +```javascript +// JSON of GraphSchema ⬇ + +``` diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..5907bb9efc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,10 @@ +blank_issues_enabled: true + +# 设置提 issue 前的参考文档 +contact_links: + - name: HugeGraph Server Doc + url: https://hugegraph.github.io/hugegraph-doc/quickstart/hugegraph-server.html + 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 + about: Please search usage here before opening a new issue diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..9f639f1f50 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,11 @@ +--- +name: Feature request (新需求 / 功能) +about: Give an idea for HugeGraph +title: '[Feature] Briefly describe the new features' +labels: 'feature' +assignees: '' +--- + +## Feature Description: + +xxx diff --git a/.github/ISSUE_TEMPLATE/question_ask.md b/.github/ISSUE_TEMPLATE/question_ask.md new file mode 100644 index 0000000000..84acd90517 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question_ask.md @@ -0,0 +1,46 @@ +--- +name: Ask question (提问) +about: Question about usage or configs in HugeGraph +title: '[Question] Briefly describe your problems here' +labels: '' +assignees: '' + +--- + +### Note ( 特别注意 ) : + +> 1. 请先**搜索**, 并**确认**现有的 [Issues](https://github.com/hugegraph/hugegraph/issues) 与 [FAQ](https://hugegraph.github.io/hugegraph-doc/guides/faq.html) 中没有与您相同 / 相关的问题, 请勿重复提交 +> 2. 我们需要尽可能**详细**的信息来**分析**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等) 会**越快**被响应和处理 +> 3. 请关注提交的 issue, 缺乏信息 / 长时间 ( > 14 天) 没有回复, issue 可能会被 **关闭** (需要时可再开启) + + +## Environment ( 环境信息 - 必填 ) +- **Server Version**: v0.11.x (refer [here](https://hugegraph.github.io/hugegraph-doc/clients/restful-api/other.html)) +- **Backend**: Cassandra 3.x, x nodes, HDD or SSD +- **OS**: xx CPUs, xx G RAM, Centos 7.x +- **Data Size**: xx vertices, xx edges (like 1000W 点, 9000W 边) + +## Your Question ( 问题描述 ) + +xxx + +> 注: 图使用 / 配置相关问题, 请优先参考 [REST-API 文档](https://hugegraph.github.io/hugegraph-doc/clients/hugegraph-api.html), 以及 [Server 配置文档](https://hugegraph.github.io/hugegraph-doc/config/config-option.html) + +### Related information ( 补充相关信息 ) : +
+ Provide related "Data & Schema" info (Click to expand) + +### Vertex/Edge example ( 问题点 / 边数据举例 ) + +```javascript +// JSON of Vertex / Edge ⬇ + +``` + +### Schema [VertexLabel, EdgeLabel, IndexLabel] ( 元数据结构 ) + +```javascript +// JSON of GraphSchema ⬇ + +``` +
diff --git a/issue_template.md b/issue_template.md deleted file mode 100644 index 7311b409de..0000000000 --- a/issue_template.md +++ /dev/null @@ -1,32 +0,0 @@ -### Expected behavior 期望表现 -{type something here...} - - -### Actual behavior 实际表现 -{type something here...} - - -### Steps to reproduce the problem 复现步骤 -1. {step 1} -2. {step 2} -3. {step 3} - - -### Status of loaded data 数据状态 - -#### Vertex/Edge summary 数据量 -- loaded vertices amount: {like 10 million} -- loaded edges amount: {like 20 million} -- loaded time: {like 200s} - -#### Vertex/Edge example 数据示例 -{type something here...} - -#### Schema(VertexLabel, EdgeLabel, IndexLabel) 元数据结构 -{type something here...} - - -### Specifications of environment 环境信息 -- hugegraph version: {like v0.7.4} -- operating system: {like centos 7.4, 32 CPUs, 64G RAM} -- hugegraph backend: {like cassandra 3.10, cluster with 20 nodes, 3 x 1TB HDD disk each node}