From 49e8599d8f46182cac00fb4a7e5ec6a3b13801ff Mon Sep 17 00:00:00 2001 From: imbajin Date: Fri, 2 Jul 2021 16:35:24 +0800 Subject: [PATCH] chore: add issue template & auto stale issues and pr (#78) --- .github/ISSUE_TEMPLATE/bug_report.yml | 96 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 7 ++ .github/ISSUE_TEMPLATE/feature_request.yml | 15 ++++ .github/ISSUE_TEMPLATE/question_ask.yml | 94 +++++++++++++++++++++ .github/workflows/ci.yml | 3 +- .github/workflows/stale.yml | 36 ++++++++ 6 files changed, 249 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/question_ask.yml create mode 100644 .github/workflows/stale.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..780d51efd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,96 @@ +name: Bug report (反馈 Bug) +description: Create a bug report to help HugeGraph improve +title: '[Bug] describe the main problem' +labels: + - bug + +body: + - type: markdown + attributes: + value: >- + ### Note (特别注意) : + + > 1. 请先**搜索**现有的[Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与 + [Common-Issues](https://github.com/hugegraph/hugegraph-common/issues) 中没有与您相同 + / 相关的问题 (请勿重复提交) + + > 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等) + 会**越快**被响应和处理 + + > 3. Issue 标题请保持原有模板分类(例如:`[Bug]`), 长段描述之间可以增加`空行`或使用`序号`标记, 保持排版清晰 + + > 4. 请在对应的模块提交 issue, 缺乏有效信息 / 长时间 (> 14 天) 没有回复的 issue 可能会被 **关闭** + (更新时会再开启) + + - type: dropdown + attributes: + label: Bug Type (问题类型) + options: + - exception / error (异常报错) + - logic (逻辑设计问题) + - performence (性能下降) + - others (please edit later) + + - type: checkboxes + attributes: + label: Before submit + options: + - label: 我已经确认现有的 [Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与 [Common-Issues](https://github.com/hugegraph/hugegraph-common/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) + value: | + - Server Version: v0.11.x + - Common Version: v1.x + 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 (请提供清晰的截图, 动图录屏更佳) + placeholder: | + type the main problem here + + ```java + // Exception / Error info (尽可能详细的日志 + 完整异常栈) + + ``` + validations: + required: true + + - type: textarea + attributes: + label: Vertex/Edge example (问题点 / 边数据举例) + description: | + > 如果问题与具体的点 / 边数据相关, 请提供完整的`查询语句 + 返回 JSON 结果` + placeholder: | + // Query URL + GET http://localhost:8080/gremlin?gremlin=hugegraph.traversal().V('1:tom') + + // JSON of Vertex / Edge + { + "vertex": { "id": "xxx" } + } + render: javascript + + - type: textarea + attributes: + label: Schema [VertexLabel, EdgeLabel, IndexLabel] (元数据结构) + description: | + > 如果问题与具体的点类型 / 边类型 / 索引类型相关, 请提供完整的 `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 000000000..10783233d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ +blank_issues_enabled: false + +# 设置提 issue 前的参考文档 +contact_links: + - 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.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..4012606e4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,15 @@ +name: Feature request (新需求 / 功能) +description: Give an idea for HugeGraph +title: '[Feature] describe the new feature' +labels: + - feature + +body: + - type: textarea + attributes: + label: Feature Description (功能描述) + description: | + > 请简要描述新功能 / 需求的使用场景或上下文, 最好能给个具体的例子说明 + placeholder: type the feature description here + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/question_ask.yml b/.github/ISSUE_TEMPLATE/question_ask.yml new file mode 100644 index 000000000..6a57883ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question_ask.yml @@ -0,0 +1,94 @@ +name: Ask question (提问) +description: Question about usage or configs in HugeGraph +title: '[Question] describe your problem' + +body: + - type: markdown + attributes: + value: >- + ### Note (特别注意) : + + > 1. 请先**搜索**现有的[Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与 + [Common-Issues](https://github.com/hugegraph/hugegraph-common/issues) 中没有与您相同 + / 相关的问题 (请勿重复提交) + + > 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等) + 会**越快**被响应和处理 + + > 3. Issue 标题请保持原有模板分类(例如:`[Bug]`), 长段描述之间可以增加`空行`或使用`序号`标记, 保持排版清晰 + + > 4. 请在对应的模块提交 issue, 缺乏有效信息 / 长时间 (> 14 天) 没有回复的 issue 可能会被 **关闭** + (更新时会再开启) + + - type: dropdown + attributes: + label: Problem Type (问题类型) + options: + - struct / logic (架构 / 逻辑设计问题) + - performence (性能优化) + - exception / error (异常报错) + - others (please edit later) + + - type: checkboxes + attributes: + label: Before submit + options: + - label: 我已经确认现有的 [Server-Issues](https://github.com/hugegraph/hugegraph/issues) 与 [Common-Issues](https://github.com/hugegraph/hugegraph-common/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) + value: | + - Server Version: v0.11.x + - Common Version: v1.x + 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: | + type the main problem here + + ```java + // Exception / Error info (尽可能详细的日志 + 完整异常栈) + + ``` + validations: + required: true + + - type: textarea + attributes: + label: Vertex/Edge example (问题点 / 边数据举例) + description: | + > 如果问题与具体的点 / 边数据相关, 请提供完整的`查询语句 + 返回 JSON 结果` + placeholder: | + // Query URL + GET http://localhost:8080/gremlin?gremlin=hugegraph.traversal().V('1:tom') + + // JSON of Vertex / Edge + { + "vertex": { "id": "xxx" } + } + render: javascript + + - type: textarea + attributes: + label: Schema [VertexLabel, EdgeLabel, IndexLabel] (元数据结构) + description: | + > 如果问题与具体的点类型 / 边类型 / 索引类型相关, 请提供完整的 `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/workflows/ci.yml b/.github/workflows/ci.yml index e7792c8d2..dbf462b56 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -43,7 +43,6 @@ jobs: mvn test -Dtest=UnitTestSuite - name: Upload coverage to Codecov - uses: codecov/codecov-action@v1.0.2 + uses: codecov/codecov-action@v1 with: - token: ${{secrets.CODECOV_TOKEN}} file: target/jacoco.xml diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml new file mode 100644 index 000000000..1813bd3cb --- /dev/null +++ b/.github/workflows/stale.yml @@ -0,0 +1,36 @@ +name: Mark stale issues and pull requests + +on: + schedule: + - cron: "0 21 * * *" + +jobs: + stale: + + runs-on: ubuntu-latest + permissions: + issues: write + pull-requests: write + + steps: + - uses: actions/stale@v3 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + 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' + 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' + stale-issue-label: 'inactive' + stale-pr-label: 'inactive' + exempt-issue-labels: 'feature,bug,enhancement,improvement,wontfix,todo' + + days-before-issue-stale: 15 + days-before-issue-close: 20 + days-before-pr-stale: 30 + days-before-pr-close: 180 + operations-per-run: 10 + start-date: '2018-12-01T00:00:00Z' + + exempt-all-assignees: true + remove-stale-when-updated: true + exempt-all-pr-milestones: true + delete-branch: false + enable-statistics: true