You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fineract.apache.org by vo...@apache.org on 2020/08/26 09:51:42 UTC

[fineract] branch vorburger-README-merge-strategy created (now f6efe58)

This is an automated email from the ASF dual-hosted git repository.

vorburger pushed a change to branch vorburger-README-merge-strategy
in repository https://gitbox.apache.org/repos/asf/fineract.git.


      at f6efe58  add Merge Strategy section to README

This branch includes the following new commits:

     new f6efe58  add Merge Strategy section to README

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



[fineract] 01/01: add Merge Strategy section to README

Posted by vo...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

vorburger pushed a commit to branch vorburger-README-merge-strategy
in repository https://gitbox.apache.org/repos/asf/fineract.git

commit f6efe58761dccf735c52123f687716db0fa8e8a5
Author: Michael Vorburger ⛑️ <mi...@vorburger.ch>
AuthorDate: Wed Aug 26 11:51:32 2020 +0200

    add Merge Strategy section to README
---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 6cbce32..c08a4b2 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 o [...]
+
+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
 -------------------