elsewhencode / elsewhencode/project-guidelines

Guidelines too opinionated about squashing commits on develop

Open
#124 2 comments 6 reactions 1 assignee Claimed by @vpanjganj View on GitHub
help wanted improvement
Dominant language
JavaScript
Stars
29.4k
Forks
3.1k
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.