From b80971e123ac4ab13c383c0db3f289a7d9037807 Mon Sep 17 00:00:00 2001 From: Aiee <18348405+Aiee@users.noreply.github.com> Date: Fri, 29 Oct 2021 15:53:05 +0800 Subject: [PATCH 1/4] Fix typos in the template --- .github/ISSUE_TEMPLATE/bug-report.md | 2 +- .github/pull_request_template.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index ddee64edb6c..ad38a7f033c 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -18,7 +18,7 @@ A clear and concise description of what the bug is. **Your Environments (__must be provided__)** * OS: `uname -a` -* Compliler: `g++ --version` or `clang++ --version` +* Compiler: `g++ --version` or `clang++ --version` * CPU: `lscpu` * Commit id (e.g. `a3ffc7d8`) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 469ab40adc0..48a49f20b83 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -16,9 +16,9 @@ close #xxx #### Checklist： -- [ ] Documentation affected （If need to modify document, please label it.) -- [ ] Incompatible （If it is incompatile, please describle it and label it.） -- [ ] Need to cherry pick （If need to cherry pick to some branchs, please label the destination version(s).) +- [ ] Documentation affected （Please add the label if documentation needs to be modified.) +- [ ] Incompatible （If it is incompatible, please describe it and label it.） +- [ ] Need to cherry-pick （If need to cherry-pick to some branches, please label the destination version(s).) - [ ] Performance regression: Consumes more CPU - [ ] Performance regression: Consumes more Memory From 916eceef4b8ad6d641993f386c37c5e3a469c68b Mon Sep 17 00:00:00 2001 From: Aiee <18348405+Aiee@users.noreply.github.com> Date: Fri, 29 Oct 2021 15:59:50 +0800 Subject: [PATCH 2/4] Fix grammar --- .github/ISSUE_TEMPLATE/bug-report.md | 6 +++--- .github/pull_request_template.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index ad38a7f033c..f05425a1117 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -11,18 +11,18 @@ assignees: '' Please check the [FAQ](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-EN/1.overview/2.quick-start/2.FAQ.md) documentation and old issues before raising an issue in case someone has asked the same question that you are asking. -**Describe the bug (__must be provided__)** +**Describe the bug (__required__)** A clear and concise description of what the bug is. -**Your Environments (__must be provided__)** +**Your Environments (__required__)** * OS: `uname -a` * Compiler: `g++ --version` or `clang++ --version` * CPU: `lscpu` * Commit id (e.g. `a3ffc7d8`) -**How To Reproduce(__must be provided__)** +**How To Reproduce(__required__)** Steps to reproduce the behavior: diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 48a49f20b83..80f879d1c47 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,7 +6,7 @@ close #xxx （If it is requirement, issue(s) number must be listed.） -#### What this PR does / why we need it? +#### What does this PR do / why we need it? #### Special notes for your reviewer, ex. impact of this fix, etc: From c84798266541c63d889395c0b67f97fba70bf330 Mon Sep 17 00:00:00 2001 From: Aiee <18348405+Aiee@users.noreply.github.com> Date: Fri, 29 Oct 2021 16:09:36 +0800 Subject: [PATCH 3/4] Add PR type --- .github/pull_request_template.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 80f879d1c47..193f101c1c4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,10 +1,10 @@ #### What type of PR is this? - [ ] bug - [ ] feature +- [ ] enhancement + +#### Which issue(s) this PR relates to?: -#### Which issue(s) this PR fixes: -close #xxx -（If it is requirement, issue(s) number must be listed.） #### What does this PR do / why we need it? From e93f1bed909c584e7657409149ac3e3eaf7697fd Mon Sep 17 00:00:00 2001 From: Aiee <18348405+Aiee@users.noreply.github.com> Date: Fri, 29 Oct 2021 16:16:28 +0800 Subject: [PATCH 4/4] Address comments --- .github/pull_request_template.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 193f101c1c4..13e059713cf 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -3,10 +3,10 @@ - [ ] feature - [ ] enhancement -#### Which issue(s) this PR relates to?: +#### What does this PR do? -#### What does this PR do / why we need it? +#### Which issue(s)/PR(s) this PR relates to? #### Special notes for your reviewer, ex. impact of this fix, etc: @@ -17,11 +17,9 @@ #### Checklist： - [ ] Documentation affected （Please add the label if documentation needs to be modified.) -- [ ] Incompatible （If it is incompatible, please describe it and label it.） +- [ ] Incompatible （If it is incompatible, please describe it and add corresponding label.） - [ ] Need to cherry-pick （If need to cherry-pick to some branches, please label the destination version(s).) -- [ ] Performance regression: Consumes more CPU -- [ ] Performance regression: Consumes more Memory - +- [ ] Performance impacted: Consumes more CPU/Memory #### Release notes：