From 893e8bb020e5683cbac900ac3610f2f55ffcf4da Mon Sep 17 00:00:00 2001 From: "shengjun.li" Date: Sat, 23 Jan 2021 11:06:42 +0800 Subject: [PATCH] update .github (#4653) * Update PULL_REQUEST_TEMPLATE.md (#2639) Signed-off-by: jinhai * optimize config code (#2996) * update Signed-off-by: wxyu * update pull request template Signed-off-by: wxyu * [skip ci] update pull request template (#3008) Signed-off-by: wxyu * [skip ci] Update PR template Signed-off-by: jinhai * update PULL_REQUEST_TEMPLATE.md Signed-off-by: shengjun.li * [skip ci] Update ISSUE template Signed-off-by: jinhai * [skip ci]fix template doc (#3268) Signed-off-by: shengjun.li * [skip ci]update issue template (#3379) Signed-off-by: Wang Xiangyu * [skip ci]remove cherry-pick section in PULL REQUEST TEMPLATE (#3571) Signed-off-by: Wang Xiangyu * [skip ci] add enhancement issue template (#3585) Signed-off-by: yudong.cai Co-authored-by: Jin Hai Co-authored-by: Wang XiangYu Co-authored-by: Cai Yudong --- .github/ISSUE_TEMPLATE/bug_report.md | 23 +++++++++++++++---- .github/ISSUE_TEMPLATE/config.yml | 5 ++++ .../ISSUE_TEMPLATE/documentation-request.md | 2 +- .github/ISSUE_TEMPLATE/enhancement.md | 15 ++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 2 ++ .github/ISSUE_TEMPLATE/general-question.md | 10 -------- .github/PULL_REQUEST_TEMPLATE.md | 17 ++++++++++---- 7 files changed, 54 insertions(+), 20 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/enhancement.md delete mode 100644 .github/ISSUE_TEMPLATE/general-question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 40cf60f3dd..ee133cd697 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,6 +7,8 @@ assignees: '' --- +**Please state your issue using the following template and, most importantly, in English.** + **Describe the bug** A clear and concise description of what the bug is. @@ -16,11 +18,24 @@ Follow this [guide](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-r **Expected behavior** A clear and concise description of what you expected to happen. +**Method of installation** +- [ ] Docker/cpu +- [ ] Docker/gpu +- [ ] Build from source + **Environment details** -- Hardware/Softward conditions (OS, CPU, GPU, Memory) -- Method of installation (Docker, or from source) -- Milvus version (v0.3.1, or v0.4.0) -- Milvus configuration (Settings you made in `server_config.yaml`) +- Hardware/Softwars conditions (OS, CPU, GPU, Memory) + + +- Milvus version (master or released version) + + +**Configuration file** +Settings you made in `server_config.yaml` or `milvus.yaml` + +```yaml +paste-file-content-here +``` **Screenshots** If applicable, add screenshots to help explain your problem. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..83b2650966 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://github.com/milvus-io/milvus/discussions + about: Ask questions and discuss with other community members diff --git a/.github/ISSUE_TEMPLATE/documentation-request.md b/.github/ISSUE_TEMPLATE/documentation-request.md index 133fb9e1e9..53e480d8d5 100644 --- a/.github/ISSUE_TEMPLATE/documentation-request.md +++ b/.github/ISSUE_TEMPLATE/documentation-request.md @@ -7,7 +7,7 @@ assignees: '' --- -## Report incorrect documentation +**Please state your issue using the following template and, most importantly, in English.** **Location of incorrect documentation** Provide links and line numbers if applicable. diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 0000000000..74ed61e07a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,15 @@ +--- +name: "Enhancement request" +about: Suggest an enhancement idea for Milvus +title: '' +labels: '' +assignees: '' + +--- + +**Please state your issue using the following template and, most importantly, in English.** + +**What would you like to be added ?** + +**Why is this needed ?** + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 01bceb3321..8b027b4e03 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,6 +7,8 @@ assignees: '' --- +**Please state your issue using the following template and, most importantly, in English.** + **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. E.g. I wish I could use Milvus to do [...] diff --git a/.github/ISSUE_TEMPLATE/general-question.md b/.github/ISSUE_TEMPLATE/general-question.md deleted file mode 100644 index d49fce1817..0000000000 --- a/.github/ISSUE_TEMPLATE/general-question.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: "\U0001F914 General question" -about: Ask a general question about Milvus -title: '' -labels: '' -assignees: '' - ---- - -**What is your question?** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 307fa950df..f499206467 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,25 @@ **What type of PR is this?** -api-change / bug / design / documentation / feature - - -**What this PR does / why we need it:** - +- [ ] API-change +- [ ] BUG +- [ ] Improvement +- [ ] Documentation +- [ ] Feature +- [ ] Test and CI +- [ ] Code Refactoring **Which issue(s) this PR fixes:** Fixes # +**What this PR does / why we need it:** + +Not Available **Special notes for your reviewer:** +Not Available **Additional documentation (e.g. design docs, usage docs, etc.):** +Not Available