From 657416aa72d44456fd0cb0a0616e7d86f3c0c4f8 Mon Sep 17 00:00:00 2001 From: Siegmeyer Date: Wed, 29 May 2019 09:09:21 +0000 Subject: [PATCH] Add guidelines on submitting batch commits --- git.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/git.md b/git.md index e7d8bec..7f9482c 100644 --- a/git.md +++ b/git.md @@ -195,6 +195,26 @@ Fix nasty little bug ISSUE-51 #resolve #time 2h30m * Keep the history *clean* and *simple*. Before pushing any branch to the public always ensure that it conforms to the style-guide. If it doesn't: squash, rebase, reword commits as necessary. + +* When merging multiple small commits into a single change, make sure to + keep high locality of the changes. In another words, if you're changing, + let's say, some elements of the UI, group changes + that occur in small vicinity of each other. + +* When merging multiple changes into one, make sure to _do not exceed + limit of 10 changes in one commit_. Additionally, always include + ticket/issue numbers in the commit log. For example: + + ```git + Improve user-experience in subscription views PROJ-10 + + This batch includes: + * Tweak padding between buttons PROJ-13 + * Ensure proper scrolling of the list-view PROJ-22 + * Fix alpha layer on the toolbar PROJ-19 + ``` + + where `PROJ-10` is a super-ticket for all subsequent issues. ### 4. Rewriting history