From 1baf72622f13654cdce0c4edf40a0b28dc45a94a Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 19 Jun 2023 10:11:16 +0800 Subject: [PATCH 1/4] chore: add pr template --- .github/PULL_REQUEST_TEMPLATE.md | 75 ++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..15c0b8c10a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,75 @@ + + +## Purpose of the PR + +- close: xxx + + + +## Main Changes + + + +## Verifying these changes + + + +- This change is a trivial rework / code cleanup without any test coverage. + +*(or)* + +- This change is already covered by existing tests, such as *(please describe tests)*. + +*(or)* + +- This change added tests and can be verified as follows: + + *(for example:)* + - *Add UT.* + + +## Does this PR potentially affect the following parts? + + + +- [ ] Nope +- [ ] Dependencies (add/update license info) +- [ ] Modify configurations +- [ ] The public API +- [ ] Other affects (typed here) + +## Documentation Status + + + +- [ ] `Doc - TODO` +- [ ] `Doc - Done` +- [ ] `Doc - NO Need` From 0e725a1fc70c197521dcd5c6b4943dab126ce204 Mon Sep 17 00:00:00 2001 From: imbajin Date: Mon, 19 Jun 2023 18:21:16 +0800 Subject: [PATCH 2/4] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 15c0b8c10a..0f7d451bf7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -23,7 +23,7 @@ published) @@ -40,21 +40,12 @@ For example: ## Verifying these changes - - -- This change is a trivial rework / code cleanup without any test coverage. - -*(or)* - -- This change is already covered by existing tests, such as *(please describe tests)*. - -*(or)* - -- This change added tests and can be verified as follows: - - *(for example:)* - - *Add UT.* + +- [ ] Trivial rework / code cleanup without any test coverage. (No Need) +- [ ] Already covered by existing tests, such as *(please modify tests here)*. +- [ ] Need tests and can be verified as follows: + - xxx ## Does this PR potentially affect the following parts? From 297d4b08898c8ac729bd7d29797d7ad475bf0273 Mon Sep 17 00:00:00 2001 From: imbajin Date: Mon, 19 Jun 2023 18:24:04 +0800 Subject: [PATCH 3/4] update close/fix synx --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0f7d451bf7..6e349b148a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -19,7 +19,7 @@ published) ## Purpose of the PR -- close: xxx +- close #xxx - [ ] `Doc - Done` -- [ ] `Doc - NO Need` +- [ ] `Doc - No Need`