Guidelines too opinionated about squashing commits on develop

Open
#124 2 comments 6 reactions 1 assignee View on GitHub

@vpanjganj is already working on this.

Since Jul 13, 2021.

Assessment

This issue has not been assessed yet.

Description

help wanted improvement

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.

Dominant language
JavaScript
Stars
29.4k
Forks
3.1k
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from elsewhencode/project-guidelines

All issues in elsewhencode/project-guidelines

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.