project-guidelines icon indicating copy to clipboard operation
project-guidelines copied to clipboard

Guidelines too opinionated about squashing commits on develop

Open arzke opened this issue 7 years ago • 2 comments

In 1.2, we can read the following:

You can use --autosquash to squash all your commits to a single commit. Nobody wants many commits for a single feature in develop branch. read more...

I think that asserting that nobody wants that is a fallacy. There are good reasons for which you would want to keep those commits separated even in develop branch:

  • know what the reason of a change was when doing a git blame, which is naturally in the commit message/description and not in the feature
  • having more precision for git bisect: squashing makes you lose information as you only know which feature caused a regression, rather than a specific commit (the latter narrows the scope)

Those are the reasons why I never squash my commits into a feature commit. You should therefore mention in your guidelines that this is subjective.

arzke avatar Jan 31 '18 09:01 arzke

Hi @brundozer , I do agree that it is opinionated. I think the aim was to keep the main branch tidy. Many commits provide valuable information within a feature branch only and this is not the case on the main branch when you look at the bigger picture. You can read more about it here. However, your point is valid too. I suggest we rephrase it in a way that provides both pros and cons and the fact that it's up to the developer after all.

vpanjganj avatar Jan 31 '18 10:01 vpanjganj

Hey @vpanjganj, Could I work on this if it is available ?

theNaut1lus avatar Mar 12 '19 19:03 theNaut1lus