Skip to content

Commit

Permalink
doc: use 3 issue template for better community experience (#1453)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
imbajin authored May 20, 2021
1 parent 0fa8cf9 commit acb7eb1
Show file tree
Hide file tree
Showing 5 changed files with 122 additions and 32 deletions.
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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 ⬇

```
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/question_ask.md
Original file line number Diff line number Diff line change
@@ -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 ( 补充相关信息 ) :
<details>
<summary> Provide related "Data & Schema" info (Click to expand) </summary>

### Vertex/Edge example ( 问题点 / 边数据举例 )

```javascript
// JSON of Vertex / Edge ⬇

```

### Schema [VertexLabel, EdgeLabel, IndexLabel] ( 元数据结构 )

```javascript
// JSON of GraphSchema ⬇

```
</details>
32 changes: 0 additions & 32 deletions issue_template.md

This file was deleted.

0 comments on commit acb7eb1

Please sign in to comment.