From faaa8b02b7daf648f0323981e6f60d2a9679857d Mon Sep 17 00:00:00 2001 From: Aaron Wang Date: Sat, 20 May 2023 00:01:05 +0800 Subject: [PATCH 1/8] improve: add pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 77 ++++++++++++++++++++++++++++++++ 1 file changed, 77 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 000000000..670f23b04 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,77 @@ + + +## Purpose of the pull request + +- This PR will close \ + + + +## Summary of changes + + + +## Verifying this change + + + +This change is a trivial rework / code cleanup without any test coverage. + +*(or)* + +This change is already covered by existing tests, such as \. + +*(or)* + +This change added tests and can be verified as follows: + +*(for example:)* + +- *Added integration tests for end-to-end deployment with large payloads (10MB)* +- *Manually verified the change by running a HugeGraphComputerJob with some network exception, verifying that Worker shuts down and job is cancelled.* + +## Does this pull request potentially affect one of the following parts: + + + +- [ ] Dependencies (add or upgrade a dependency, do not forget to add license) +- [ ] The public API +- [ ] The default values of configurations +- [ ] The CRD generation script +- [ ] The Kubernetes Operator +- [ ] Anything that affects deployment + +## Documentation + + + +- [ ] `doc-required` +- [ ] `doc-not-needed` +- [ ] `doc-complete` From 62b4102c30ab3e512ae25d6e68b728b8883e5b87 Mon Sep 17 00:00:00 2001 From: Aaron Wang Date: Sat, 20 May 2023 00:05:44 +0800 Subject: [PATCH 2/8] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 670f23b04..fb36e2f2d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -19,7 +19,7 @@ ## Purpose of the pull request -- This PR will close \ +- This PR will close -This change is a trivial rework / code cleanup without any test coverage. +- This change is a trivial rework / code cleanup without any test coverage. *(or)* -This change is already covered by existing tests, such as . +- This change is already covered by existing tests, such as . *(or)* -This change added tests and can be verified as follows: - -*(for example:)* +- This change added tests and can be verified as follows: + + *(for example:)* + - *Added integration tests for end-to-end deployment with large payloads (10MB)* + - *Manually verified the change by running a HugeGraphComputerJob with some network exception, verifying that Worker shuts down and job is cancelled.* -- *Added integration tests for end-to-end deployment with large payloads (10MB)* -- *Manually verified the change by running a HugeGraphComputerJob with some network exception, verifying that Worker shuts down and job is cancelled.* ## Does this pull request potentially affect one of the following parts: From f2a0b1bc603e5e2dd628eb3cf1a3dd0169fda3e2 Mon Sep 17 00:00:00 2001 From: Aaron Wang Date: Sat, 20 May 2023 00:53:56 +0800 Subject: [PATCH 4/8] fix: modify change to changes --- .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 6d0206beb..9a5c5ec44 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -38,7 +38,7 @@ For example: - If you refactor some codes with changing classes, showing the class hierarchy will help reviewers. - If there is a discussion in the mailing list, please add the link. --> -## Verifying this change +## Verifying these changes From 55472d2f63aff37620da7c9d796d8653bff65fda Mon Sep 17 00:00:00 2001 From: imbajin Date: Sat, 20 May 2023 21:04:05 +0800 Subject: [PATCH 5/8] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 70 +++++++++++--------------------- 1 file changed, 24 insertions(+), 46 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9a5c5ec44..0217fb832 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,34 +1,32 @@ -## Purpose of the pull request +## Purpose of the PR -- This PR will close - - + +- If you fix a bug, you can clarify why it is a bug, and should associated with a #issue_number +--> -## Summary of changes +## 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 . - -*(or)* - -- This change added tests and can be verified as follows: - - *(for example:)* - - *Added integration tests for end-to-end deployment with large payloads (10MB)* - - *Manually verified the change by running a HugeGraphComputerJob with some network exception, verifying that Worker shuts down and job is cancelled.* - - -## Does this pull request potentially affect one of the following parts: +## Does this PR potentially affect the following parts? -- [ ] Dependencies (add or upgrade a dependency, do not forget to add license) +- [ ] Nope +- [ ] Dependencies (add/update license info) +- [ ] Modify configurations - [ ] The public API -- [ ] The default values of configurations -- [ ] The CRD generation script -- [ ] The Kubernetes Operator -- [ ] Anything that affects deployment +- [ ] Other affects (typed here) -## Documentation +## Documentation Status -- [ ] `doc-required` -- [ ] `doc-not-needed` -- [ ] `doc-complete` +- [ ] `Doc - TODO` +- [ ] `Doc - Done` +- [ ] `Doc - NO Need` From 31ea3e02b731255f42e877dd82ee45d0a1f5182d Mon Sep 17 00:00:00 2001 From: Aaron Wang Date: Sat, 20 May 2023 21:35:33 +0800 Subject: [PATCH 6/8] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0217fb832..113bad62d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -17,7 +17,7 @@ ## Purpose of the PR -close #xx +- close: xxx +## 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? From affad07941e91cd8d9588545bb0e454935949ea9 Mon Sep 17 00:00:00 2001 From: Aaron Wang Date: Tue, 23 May 2023 00:38:16 +0800 Subject: [PATCH 7/8] Update PULL_REQUEST_TEMPLATE.md --- .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 113bad62d..45f355f34 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,7 +4,7 @@ Here are some tips for you: 1. If this is your first time, please read the [contributing guidelines](https://github.com/apache/hugegraph/blob/master/CONTRIBUTING.md) - 2. If a PR will fix/close a issue, type the message "fix #xx" (xx = issue number) in the content, github will auto link it (Required) + 2. If a PR will fix/close a issue, type the message "close xxx" (xxx is the link of related issue) in the content, github will auto link it (Required) 3. Name the PR title in "Google Commit Format", start with "feat | fix | perf | refactor | doc | chore", such like: "feat(core): support the PageRank algorithm" or "fix: wrong break in the compute loop" (module is optional) From 14897e5cae0bd37c5a321b2377025147badf3708 Mon Sep 17 00:00:00 2001 From: Aaron Wang Date: Tue, 23 May 2023 00:41:42 +0800 Subject: [PATCH 8/8] Update PULL_REQUEST_TEMPLATE.md --- .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 45f355f34..578415b7e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -23,7 +23,7 @@ Please explain more context in this section, clarify why the changes are needed. For example: - If you propose a new API, clarify the use case for a new API. -- If you fix a bug, you can clarify why it is a bug, and should associated with a #issue_number +- If you fix a bug, you can clarify why it is a bug, and should associated with an issue. --> ## Main Changes