git how to modify the description of commit

How to modify Git commit information: Modify the last commit information: git commit --amend -m "New commit information" Submission information before modifying: git rebase -i HEAD~n, select reward to modify information (use with caution, especially when multi-person collaboration) Standardize commit information: Follow the 50/72 rules and describe the modification content clearly and concisely

Rewrite the Git commit message and don’t let history be shamed!

Many times, after submitting the code, I find that the commit message is written in a messy way, or it is simply wrong. This feels like I find that the title is wrong after writing the paper, which makes people crazy. Don't worry, Git provides a way to modify commit message, allowing you to gracefully correct history and maintain the cleanliness of your code base. After reading this article, you will be able to easily master the skills of modifying commit information and understand the principles behind it to avoid falling into the pit again.

Let me first talk about a basic concept: Git's commit record is immutable, which sounds rigid, but in fact, the cleverness of Git is that it does not really modify history, but creates a new commit to replace the old one. After understanding this, many problems will be solved.

The most commonly used method is git commit --amend . This thing is like a "regret medicine" that can modify the message you submitted last time. For example, if you just submitted a commit and found that the description was written incorrectly, then:

 <code class="bash">git commit --amend -m "This is the corrected commit message"</code>

This line of command will create a new commit. The content of the new commit is exactly the same as before, except that the message has been modified. The original commit is like being erased by a time machine, leaving only the revised version. Simple and crude, efficient and practical. Remember that the -m parameter is followed by the new commit message.

But what if you want to modify the previous commit? --amend is powerless. At this time, you need to use git rebase -i HEAD~n (where n represents the number of commits you want to modify). This command will open an interactive interface, allowing you to choose which commit to modify. Selecting reword can modify the corresponding commit message. This is an advanced operation, please be careful! Especially if you have pushed to the remote repository, don't rebase directly, otherwise it will cause huge trouble to collaboration. The correct way is to first git pull --rebase , and then perform rebase operations.

Speaking of this, I have to remind you that revising history is not a joke. Especially for projects that are collaborated by multiple people, modifying the history of shared branches at will, which will cause your teammates to collapse. Therefore, developing good submission habits and carefully checking the commit message before submitting is the king. Instead of making remedies afterwards, it is better to do it in advance.

Let’s talk about some pitfalls:

• The risk of git rebase -i : it rewrites the commit history, and if someone has already done the work based on the commit you modified, it will create conflicts and even cause the project to crash. So, unless absolutely necessary, don't use git rebase -i on public branches.
• The specification of commit message: A good commit message should clearly and concisely describe what this commit did, why it was done, and how it was done. Following certain specifications, such as the 50/72 rule (the subject line does not exceed 50 characters, the description line does not exceed 72 characters), can greatly improve the readability and maintainability of the code.

Finally, I would like to say that the power of Git is its flexibility and controllability, but this flexibility and controllability also requires us to use it with caution. Only by mastering Git's commands and understanding the principles behind them can you truly control it and make it a weapon for you to improve efficiency, rather than a burden that makes you a headache. Remember, write a commit message, starting now!

The above is the detailed content of git how to modify the description of commit. For more information, please follow other related articles on the PHP Chinese website!