From f6efe58761dccf735c52123f687716db0fa8e8a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Vorburger=20=E2=9B=91=EF=B8=8F?= Date: Wed, 26 Aug 2020 11:51:32 +0200 Subject: [PATCH 1/7] add Merge Strategy section to README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 6cbce32dde5..c08a4b2ce23 100644 --- a/README.md +++ b/README.md @@ -338,6 +338,19 @@ them in different commits. This helps review to review your code faster. We have an automated Bot which marks pull requests as "stale" after a while, and ultimately automatically closes them. + +Merge Strategy +-------------- + +We request that your commit message include a FINERACT JIRA issue, recommended to be put in parenthesis add the end of the first line. Start with an upper case imperative verb (not past form), and a short but concise clear description. (E.g. _Add enforced HideUtilityClassConstructor checkstyle (FINERACT-821)_ or _Fix inability to reschedule when interest accrued larger than EMI (FINERACT-1109)_ etc.). + +This project's committers typically prefer to bring your Pull Requests in through _Rebase and Merge_ instead of _Create a Merge Commit_. (If you are unfamiliar with GitHub's UI re. this, note the somewhat hidden little triangle drop-down at the bottom of PR, visible only to committers, not contributors.) This avoids the "merge commits" which we consider to be somewhat "polluting" the projects commits log history view. We understand this doesn't give an easy automatic reference to the original PR (which GitHub automatically adds to the Merge Commit message it generates), but we consider this an only very minor inconvenience; it's typically relatively easy to find the original PR even just from the commit message, and JIRA. + +We expect most proposed PRs to typically consist of a single commit. Committers may use _Squash and merge_ to combine your commits at merge time, and if they do so will rewrite your commit message as they see fit. + +Neither of these two are hard absolute rules, but mere conventions. Multiple commits in singl PR make sense in certain cases (e.g. branch backports). + + Dependency Upgrades ------------------- From d62fb2296cd44ddf5061a0fe5c4dfebf1554ebc3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Vorburger=20=E2=9B=91=EF=B8=8F?= Date: Wed, 26 Aug 2020 12:26:35 +0200 Subject: [PATCH 2/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c08a4b2ce23..c7de127ba0c 100644 --- a/README.md +++ b/README.md @@ -348,7 +348,7 @@ This project's committers typically prefer to bring your Pull Requests in throug We expect most proposed PRs to typically consist of a single commit. Committers may use _Squash and merge_ to combine your commits at merge time, and if they do so will rewrite your commit message as they see fit. -Neither of these two are hard absolute rules, but mere conventions. Multiple commits in singl PR make sense in certain cases (e.g. branch backports). +Neither of these two are hard absolute rules, but mere conventions. Multiple commits in single PR make sense in certain cases (e.g. branch backports). Dependency Upgrades From de784699e59117a0a03efbd0a8ade131ab332727 Mon Sep 17 00:00:00 2001 From: Michael Vorburger Date: Wed, 26 Aug 2020 12:39:10 +0200 Subject: [PATCH 3/7] improve PR Template (and move commit message blurb in README) --- .github/PULL_REQUEST_TEMPLATE.MD | 21 +++++++++++++-------- README.md | 4 ++-- 2 files changed, 15 insertions(+), 10 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.MD b/.github/PULL_REQUEST_TEMPLATE.MD index 39568c5e88e..deacd038df3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.MD +++ b/.github/PULL_REQUEST_TEMPLATE.MD @@ -1,19 +1,24 @@ ## Description -Describe the changes made and why they were made. Ignore if these details are present on the associated Jira ticket + +Describe the changes made and why they were made. + +Ignore if these details are present on the associated [Apache Fineract JIRA ticket](https://github.com/apache/fineract/pull/1284). + ## Checklist + Please make sure these boxes are checked before submitting your pull request - thanks! -- [ ] Commit message starts with the issue number from https://issues.apache.org/jira/projects/FINERACT/. Ex: FINERACT-646 Pockets API. +- [ ] Write the commit message as per https://github.com/apache/fineract/#pull-requests -- [ ] Coding conventions at https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions have been followed. +- [ ] Acknowledge that we will not review PRs that are not passing the build _("green")_ - it is your responsability to get a proposed PR to pass the build, not primarily the project's maintainers. -- [ ] API documentation at fineract-provider/src/main/resources/static/api-docs/apiLive.htm has been updated with details of any API changes. +- [ ] Create/update unit or integration tests for verifying the changes made. -- [ ] Integration tests have been created/updated for verifying the changes made. +- [ ] Follow coding conventions at https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions have been followed. -- [ ] All Integrations tests are passing with the new commits. +- [ ] Add required Swagger annotation and updated API documentation at fineract-provider/src/main/resources/static/api-docs/apiLive.htm with details of any API changes -- [ ] Submission is not a "code dump". (Large changes can be made "in repository" via a branch. Ask on the list.) +- [ ] Submission is not a "code dump". (Large changes can be made "in repository" via a branch. Ask on the developer mailling list for guidance, if required.) -Our guidelines for code reviews is at https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide +FYI our guidelines for code reviews are at https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide. diff --git a/README.md b/README.md index c7de127ba0c..8d40ae78104 100644 --- a/README.md +++ b/README.md @@ -318,6 +318,8 @@ Logging Guidelines Pull Requests ------------- +We request that your commit message include a FINERACT JIRA issue, recommended to be put in parenthesis add the end of the first line. Start with an upper case imperative verb (not past form), and a short but concise clear description. (E.g. _Add enforced HideUtilityClassConstructor checkstyle (FINERACT-821)_ or _Fix inability to reschedule when interest accrued larger than EMI (FINERACT-1109)_ etc.). + If your PR is failing to pass our CI build due to a test failure, then: 1. Understand if the failure is due to your PR or an unrelated unstable test. @@ -342,8 +344,6 @@ We have an automated Bot which marks pull requests as "stale" after a while, and Merge Strategy -------------- -We request that your commit message include a FINERACT JIRA issue, recommended to be put in parenthesis add the end of the first line. Start with an upper case imperative verb (not past form), and a short but concise clear description. (E.g. _Add enforced HideUtilityClassConstructor checkstyle (FINERACT-821)_ or _Fix inability to reschedule when interest accrued larger than EMI (FINERACT-1109)_ etc.). - This project's committers typically prefer to bring your Pull Requests in through _Rebase and Merge_ instead of _Create a Merge Commit_. (If you are unfamiliar with GitHub's UI re. this, note the somewhat hidden little triangle drop-down at the bottom of PR, visible only to committers, not contributors.) This avoids the "merge commits" which we consider to be somewhat "polluting" the projects commits log history view. We understand this doesn't give an easy automatic reference to the original PR (which GitHub automatically adds to the Merge Commit message it generates), but we consider this an only very minor inconvenience; it's typically relatively easy to find the original PR even just from the commit message, and JIRA. We expect most proposed PRs to typically consist of a single commit. Committers may use _Squash and merge_ to combine your commits at merge time, and if they do so will rewrite your commit message as they see fit. From 5360090fe1c8373024a8cee53d26bb23a406b957 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Vorburger=20=E2=9B=91=EF=B8=8F?= Date: Sun, 6 Sep 2020 19:07:14 +0200 Subject: [PATCH 4/7] Update .github/PULL_REQUEST_TEMPLATE.MD Co-authored-by: Petri Tuomola --- .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 deacd038df3..1d41adbbe25 100644 --- a/.github/PULL_REQUEST_TEMPLATE.MD +++ b/.github/PULL_REQUEST_TEMPLATE.MD @@ -11,7 +11,7 @@ Please make sure these boxes are checked before submitting your pull request - t - [ ] Write the commit message as per https://github.com/apache/fineract/#pull-requests -- [ ] Acknowledge that we will not review PRs that are not passing the build _("green")_ - it is your responsability to get a proposed PR to pass the build, not primarily the project's maintainers. +- [ ] Acknowledge that we will not review PRs that are not passing the build _("green")_ - it is your responsibility to get a proposed PR to pass the build, not primarily the project's maintainers. - [ ] Create/update unit or integration tests for verifying the changes made. From 23e8a257b6a9dd358c1947692de5ef8362ae4a44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Vorburger=20=E2=9B=91=EF=B8=8F?= Date: Sun, 6 Sep 2020 19:07:48 +0200 Subject: [PATCH 5/7] Update .github/PULL_REQUEST_TEMPLATE.MD Co-authored-by: Petri Tuomola --- .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 1d41adbbe25..eb9a0694a44 100644 --- a/.github/PULL_REQUEST_TEMPLATE.MD +++ b/.github/PULL_REQUEST_TEMPLATE.MD @@ -15,7 +15,7 @@ Please make sure these boxes are checked before submitting your pull request - t - [ ] Create/update unit or integration tests for verifying the changes made. -- [ ] Follow coding conventions at https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions have been followed. +- [ ] Follow coding conventions at https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions. - [ ] Add required Swagger annotation and updated API documentation at fineract-provider/src/main/resources/static/api-docs/apiLive.htm with details of any API changes From 742acb4544f8ec99e39a796ec28c2b45aefd0ad5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Vorburger=20=E2=9B=91=EF=B8=8F?= Date: Sun, 6 Sep 2020 19:08:00 +0200 Subject: [PATCH 6/7] Update .github/PULL_REQUEST_TEMPLATE.MD Co-authored-by: Petri Tuomola --- .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 eb9a0694a44..0d540097edf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.MD +++ b/.github/PULL_REQUEST_TEMPLATE.MD @@ -17,7 +17,7 @@ Please make sure these boxes are checked before submitting your pull request - t - [ ] Follow coding conventions at https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions. -- [ ] Add required Swagger annotation and updated API documentation at fineract-provider/src/main/resources/static/api-docs/apiLive.htm with details of any API changes +- [ ] Add required Swagger annotation and update API documentation at fineract-provider/src/main/resources/static/api-docs/apiLive.htm with details of any API changes - [ ] Submission is not a "code dump". (Large changes can be made "in repository" via a branch. Ask on the developer mailling list for guidance, if required.) From 13e1536f2019803c10dcfaf34bb1dd7dc521e3ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20Vorburger=20=E2=9B=91=EF=B8=8F?= Date: Sun, 6 Sep 2020 19:08:13 +0200 Subject: [PATCH 7/7] Update .github/PULL_REQUEST_TEMPLATE.MD Co-authored-by: Petri Tuomola --- .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 0d540097edf..a0defbcb157 100644 --- a/.github/PULL_REQUEST_TEMPLATE.MD +++ b/.github/PULL_REQUEST_TEMPLATE.MD @@ -19,6 +19,6 @@ Please make sure these boxes are checked before submitting your pull request - t - [ ] Add required Swagger annotation and update API documentation at fineract-provider/src/main/resources/static/api-docs/apiLive.htm with details of any API changes -- [ ] Submission is not a "code dump". (Large changes can be made "in repository" via a branch. Ask on the developer mailling list for guidance, if required.) +- [ ] Submission is not a "code dump". (Large changes can be made "in repository" via a branch. Ask on the developer mailing list for guidance, if required.) FYI our guidelines for code reviews are at https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide.