Skip to content

Reorder squash message to ease readibility. #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 24, 2021

Conversation

topher200
Copy link
Contributor

After using this in practice, I think that having the patch number
followed by the patch name is more readable. With this change it's
easier to scan the commit message to determine where each change
ends and the next one begins.

Before:
before

After:
image

I recognize that this PR is more personal preference; it's not the end
of the world if we leave it as-is.

After using this in practice, I think that having the patch number
followed by the patch name is more readable. With this change it's
easier to scan the commit message to determine where each change
ends and the next one begins.

Before:

After:

I recognize that this PR is more personal preference; it's not the end
of the world if we leave it as-is.
@jpgrayson jpgrayson merged commit 7091f9d into stacked-git:master Jun 24, 2021
@jpgrayson
Copy link
Collaborator

I like this updated form better too. Glad you're optimizing this.

Another possible modification to consider: show the squashed patch name somewhere. Possibly on the first line. E.g.:

# squashed-patch-name is a combination of N patches

or

# Squashing N patches as squashed-patch-name

The latter would be better if reusing the name of one of the patches being squashed (which I often do).

@topher200 topher200 deleted the reorder-squash-message branch July 6, 2021 04:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants