From 929305ad8113bb8e33377fe2bd68a782a2d96a0c Mon Sep 17 00:00:00 2001 From: josh-wong Date: Mon, 25 Sep 2023 11:34:22 +0900 Subject: [PATCH 1/5] Update pull_request_template.md --- .github/pull_request_template.md | 35 +++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 456669e..d87d8d9 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,25 +1,36 @@ ## Description -Please provide a brief description of the why this PR is necessary and the changes introduced in this pull request. +> Provide a brief description about **why** this PR is necessary. Be sure to provide context. -## Related Issue(s) +## Related issues and/or PRs -If this PR addresses or references any issues, please list them here. For example, "Fixes #123" or "Addresses #456". +> If this PR addresses or references any issues and/or other PRs, list them here. For example, "Fixes #123", "Related to #456", or "Addresses #789". -## Changes Made +## Changes made -Outline the specific changes made in this pull request. Include relevant details such as added features, bug fixes, code refactoring, or improvements. +> Outline the specific changes made in this pull request. Include relevant details, such as added features, bug fixes, code refactoring, or improvements. -## Testing Done +## How these changes were tested -Describe the testing you have performed to ensure the changes are working as expected. Include details of the test cases or scenarios covered. +> Describe the testing that you have performed to ensure the changes are working as expected. Include details about the test cases or scenarios covered. ## Checklist -- [ ] Unit tests have been added for the changes. (if applicable). -- [ ] The documentation has been updated to reflect the changes (if applicable). -- [ ] Any remaining open issues linked to this PR are documented (JIRA,GitHub). +- [ ] I have commented my code, particularly in hard-to-understand areas. +- [ ] I have updated the documentation to reflect the changes. +- [ ] Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.). +- [ ] Tests (unit, integration, etc.) have been added for the changes. +- [ ] My changes generate no new warnings. +- [ ] Any dependent changes in other PRs have been merged and published. -## Additional Notes (optional) +## Additional notes (optional) -Provide any additional information or notes that may be relevant to the reviewers or stakeholders. +> Provide any additional information or notes that may be relevant to the reviewers or stakeholders. + +## Release notes + +> Provide release note text for this PR based on the guidelines at [Guidelines for Writing Release Notes](https://developers.scalar-labs.com/docs/style-guide/release-notes/). +> +> For example: +> +> Added validation for the Consensus Commit mutation operation. From f0c600e91c865faec18c5173bd46564cae37221c Mon Sep 17 00:00:00 2001 From: josh-wong Date: Mon, 25 Sep 2023 14:30:09 +0900 Subject: [PATCH 2/5] Update pull_request_template.md Making change to skip ci on push --- .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 d87d8d9..a2991a2 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -33,4 +33,4 @@ > > For example: > -> Added validation for the Consensus Commit mutation operation. +> Added validation for the Consensus Commit mutation operation. \ No newline at end of file From 645b4efc004df84b48914eb328e7568c37f5945e Mon Sep 17 00:00:00 2001 From: josh-wong Date: Mon, 25 Sep 2023 14:30:17 +0900 Subject: [PATCH 3/5] Update pull_request_template.md [skip ci] --- .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 a2991a2..d87d8d9 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -33,4 +33,4 @@ > > For example: > -> Added validation for the Consensus Commit mutation operation. \ No newline at end of file +> Added validation for the Consensus Commit mutation operation. From 372950f288d08bd4d570a72e5bcb19b29be34336 Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Wed, 27 Sep 2023 20:02:43 +0900 Subject: [PATCH 4/5] Revise descriptions [skip ci] Add `Checklist` description, and revise the `Related issues and/or PRs` description since the previous description might conflict with how GitHub handles PR linking. Ref: https://github.com/scalar-labs/scalardb/pull/1114 --- .github/pull_request_template.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d87d8d9..339ca08 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,7 +4,7 @@ ## Related issues and/or PRs -> If this PR addresses or references any issues and/or other PRs, list them here. For example, "Fixes #123", "Related to #456", or "Addresses #789". +> If this PR addresses or references any issues and/or other PRs, list them here. ## Changes made @@ -16,6 +16,8 @@ ## Checklist +> The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item. + - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] I have updated the documentation to reflect the changes. - [ ] Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.). From 83b67bcd57d20e06e05809d4d7ec56002acfcd68 Mon Sep 17 00:00:00 2001 From: Josh Wong Date: Fri, 29 Sep 2023 11:43:23 +0900 Subject: [PATCH 5/5] Remove `How these changes were tested` section [skip ci] --- .github/pull_request_template.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 339ca08..455f3c0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,10 +10,6 @@ > Outline the specific changes made in this pull request. Include relevant details, such as added features, bug fixes, code refactoring, or improvements. -## How these changes were tested - -> Describe the testing that you have performed to ensure the changes are working as expected. Include details about the test cases or scenarios covered. - ## Checklist > The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.