Skip to content
This repository was archived by the owner on Dec 28, 2025. It is now read-only.

Commit 531b222

Browse files
imbajinimbajin
authored
chore: add issue template & auto stale issues and pr (#319)
1 parent 3bcd5c2 commit 531b222

File tree

5 files changed

+254
-0
lines changed

5 files changed

+254
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
name: Bug report (反馈 Bug)
2+
description: Create a bug report to help HugeGraph improve
3+
title: '[Bug] describe the main problem'
4+
labels:
5+
- bug
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: >-
11+
### Note (特别注意) :
12+
13+
> 1. 请先**搜索**现有的[Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与
14+
[Hubble-Issues](https://github.com/hugegraph/hugegraph-hubble/issues) 中没有与您相同
15+
/ 相关的问题 (请勿重复提交)
16+
17+
> 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等)
18+
会**越快**被响应和处理
19+
20+
> 3. Issue 标题请保持原有模板分类(例如:`[Bug]`), 长段描述之间可以增加`空行`或使用`序号`标记, 保持排版清晰
21+
22+
> 4. 请在对应的模块提交 issue, 缺乏有效信息 / 长时间 (> 14 天) 没有回复的 issue 可能会被 **关闭**
23+
(更新时会再开启)
24+
25+
- type: dropdown
26+
attributes:
27+
label: Bug Type (问题类型)
28+
options:
29+
- exception / error (异常报错)
30+
- struct / logic (功能 / 逻辑设计问题)
31+
- dashboard render (前端渲染问题)
32+
- others (please edit later)
33+
34+
- type: checkboxes
35+
attributes:
36+
label: Before submit
37+
options:
38+
- label: 我已经确认现有的 [Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与 [Hubble-Issues](https://github.com/hugegraph/hugegraph-hubble/issues) 中没有相同 / 重复问题
39+
required: true
40+
41+
- type: textarea
42+
attributes:
43+
label: Environment (环境信息)
44+
description: |
45+
> server version could get from [rest-api](https://hugegraph.github.io/hugegraph-doc/clients/restful-api/other.html) (http://localhost:8080/versions)
46+
value: |
47+
- Server Version: v0.11.x
48+
- Hubble Version: v1.x
49+
- Data Size: xx vertices, xx edges <!-- (like 1000W 点, 9000W 边) -->
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
attributes:
55+
label: Expected & Actual behavior (期望与实际表现)
56+
description: |
57+
> we can refer [How to create a minimal reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example) (如何提供最简的可复现用例)
58+
> if possible, please provide screenshots or GIF (请提供清晰的截图, 动图录屏更佳)
59+
placeholder: |
60+
type the main problem here
61+
62+
```java
63+
// Exception / Error info (尽可能详细的日志 + 完整异常栈)
64+
65+
```
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
attributes:
71+
label: Vertex/Edge example (问题点 / 边数据举例)
72+
description: |
73+
> 如果问题与具体的点 / 边数据相关, 请提供完整的`查询语句 + 返回 JSON 结果`
74+
placeholder: |
75+
// Query URL
76+
GET http://localhost:8080/gremlin?gremlin=hugegraph.traversal().V('1:tom')
77+
78+
// JSON of Vertex / Edge
79+
{
80+
"vertex": { "id": "xxx" }
81+
}
82+
render: javascript
83+
84+
- type: textarea
85+
attributes:
86+
label: Schema [VertexLabel, EdgeLabel, IndexLabel] (元数据结构)
87+
description: |
88+
> 如果问题与具体的点类型 / 边类型 / 索引类型相关, 请提供完整的 `Schema 返回 JSON 结果`
89+
placeholder: |
90+
// Query URL
91+
GET http://localhost:8080/graphs/hugegraph/schema/vertexlabels
92+
93+
// JSON of GraphSchema
94+
{
95+
"vertex": { "id": "xxx" }
96+
}
97+
render: javascript

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
blank_issues_enabled: false
2+
3+
# 设置提 issue 前的参考文档
4+
contact_links:
5+
- name: HugeGraph Hubble Doc
6+
url: https://hugegraph.github.io/hugegraph-doc/quickstart/hugegraph-hubble.html
7+
about: Please search question here before opening a new issue
8+
- name: HugeGraph API Doc
9+
url: https://hugegraph.github.io/hugegraph-doc/clients/hugegraph-api.html
10+
about: Please search usage here before opening a new issue

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Feature request (新需求 / 功能)
2+
description: Give an idea for HugeGraph
3+
title: '[Feature] describe the new feature'
4+
labels:
5+
- feature
6+
7+
body:
8+
- type: textarea
9+
attributes:
10+
label: Feature Description (功能描述)
11+
description: |
12+
> 请简要描述新功能 / 需求的使用场景或上下文, 最好能给个具体的例子说明
13+
placeholder: type the feature description here (better with a picture)
14+
validations:
15+
required: true

‎.github/ISSUE_TEMPLATE/question_ask.yml‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: Ask question (提问)
2+
description: Question about usage or configs in HugeGraph
3+
title: '[Question] describe your problem'
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >-
9+
### Note (特别注意) :
10+
11+
> 1. 请先**搜索**现有的[Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与
12+
[Hubble-Issues](https://github.com/hugegraph/hugegraph-hubble/issues) 中没有与您相同
13+
/ 相关的问题 (请勿重复提交)
14+
15+
> 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等)
16+
会**越快**被响应和处理
17+
18+
> 3. Issue 标题请保持原有模板分类(例如:`[Bug]`), 长段描述之间可以增加`空行`或使用`序号`标记, 保持排版清晰
19+
20+
> 4. 请在对应的模块提交 issue, 缺乏有效信息 / 长时间 (> 14 天) 没有回复的 issue 可能会被 **关闭**
21+
(更新时会再开启)
22+
23+
- type: dropdown
24+
attributes:
25+
label: Problem Type (问题类型)
26+
options:
27+
- exception / error (异常报错)
28+
- struct / logic (功能 / 逻辑设计问题)
29+
- dashboard render (前端渲染问题)
30+
- performence (性能优化)
31+
- others (please edit later)
32+
33+
- type: checkboxes
34+
attributes:
35+
label: Before submit
36+
options:
37+
- label: 我已经确认现有的 [Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与 [Hubble-Issues](https://github.com/hugegraph/hugegraph-hubble/issues) 中没有相同 / 重复问题
38+
required: true
39+
40+
- type: textarea
41+
attributes:
42+
label: Environment (环境信息)
43+
description: |
44+
> server version could get from [rest-api](https://hugegraph.github.io/hugegraph-doc/clients/restful-api/other.html) (http://localhost:8080/versions)
45+
value: |
46+
- Server Version: v0.11.x
47+
- Hubble Version: v1.x
48+
- Data Size: xx vertices, xx edges <!-- (like 1000W 点, 9000W 边) -->
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
attributes:
54+
label: Your Question (问题描述)
55+
description: |
56+
> 图使用 / 配置相关问题，请优先参考 [REST-API 文档](https://hugegraph.github.io/hugegraph-doc/clients/hugegraph-api.html), 以及 [Server 配置文档](https://hugegraph.github.io/hugegraph-doc/config/config-option.html)
57+
> if possible, please provide screenshots or GIF (请提供清晰的截图, 动图录屏更佳)
58+
placeholder: |
59+
type the main problem here
60+
61+
```java
62+
// Exception / Error info (尽可能详细的日志 + 完整异常栈)
63+
64+
```
65+
validations:
66+
required: true
67+
68+
- type: textarea
69+
attributes:
70+
label: Vertex/Edge example (问题点 / 边数据举例)
71+
description: |
72+
> 如果问题与具体的点 / 边数据相关, 请提供完整的`查询语句 + 返回 JSON 结果`
73+
placeholder: |
74+
// Query URL
75+
GET http://localhost:8080/gremlin?gremlin=hugegraph.traversal().V('1:tom')
76+
77+
// JSON of Vertex / Edge
78+
{
79+
"vertex": { "id": "xxx" }
80+
}
81+
render: javascript
82+
83+
- type: textarea
84+
attributes:
85+
label: Schema [VertexLabel, EdgeLabel, IndexLabel] (元数据结构)
86+
description: |
87+
> 如果问题与具体的点类型 / 边类型 / 索引类型相关, 请提供完整的 `Schema 返回 JSON 结果`
88+
placeholder: |
89+
// Query URL
90+
GET http://localhost:8080/graphs/hugegraph/schema/vertexlabels
91+
92+
// JSON of GraphSchema
93+
{
94+
"vertex": { "id": "xxx" }
95+
}
96+
render: javascript

‎.github/workflows/stale.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Mark stale issues and pull requests
2+
3+
on:
4+
schedule:
5+
- cron: "0 21 * * *"
6+
7+
jobs:
8+
stale:
9+
10+
runs-on: ubuntu-latest
11+
permissions:
12+
issues: write
13+
pull-requests: write
14+
15+
steps:
16+
- uses: actions/stale@v3
17+
with:
18+
repo-token: ${{ secrets.GITHUB_TOKEN }}
19+
stale-issue-message: 'Due to the lack of activity, the current issue is marked as stale and will be closed after 20 days, any update will remove the stale label'
20+
stale-pr-message: 'Due to the lack of activity, the current pr is marked as stale and will be closed after 180 days, any update will remove the stale label'
21+
stale-issue-label: 'inactive'
22+
stale-pr-label: 'inactive'
23+
exempt-issue-labels: 'feature,bug,enhancement,improvement,wontfix,todo'
24+
25+
days-before-issue-stale: 15
26+
days-before-issue-close: 20
27+
days-before-pr-stale: 30
28+
days-before-pr-close: 180
29+
operations-per-run: 10
30+
start-date: '2018-12-01T00:00:00Z'
31+
32+
exempt-all-assignees: true
33+
remove-stale-when-updated: true
34+
exempt-all-pr-milestones: true
35+
delete-branch: false
36+
enable-statistics: true

0 commit comments

Comments
 (0)