In this kata I would like to clean up my history a bit.
The five newest commits all tinker with file.txt which obviously contains my feature.
I would like these commits to be squashed into a single commit!
While you are at it I would really like the ugly \n
characters inside file.txt
to be removed from the history.
- Run
source setup.sh
(or.\setup.ps1
in PowerShell)
- Squash the five relevant commits into one and make a good commit message (see Further information).
- How does
git log
look now? - Clean up the
\n
characters insidefile.txt
without adding to the commit history.
git rebase -i <ref>
git add
git commit --amend
From How to Write a Git Commit Message
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
Example
Summarize changes in around 50 characters or less
More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
blank line separating the summary from the body is critical (unless
you omit the body entirely); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.
Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequences of this
change? Here's the place to explain them.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the bullet, preceded
by a single space, with blank lines in between, but conventions
vary here
If you use an issue tracker, put references to them at the bottom,
like this:
Resolves: #123
See also: #456, #789