In daily programming collaboration, the quality of Git commit records often reflects an engineer's engineering literacy. However, I frequently see some non-standard commit records that are quite embarrassing.
For example:
This is likely due to making changes after a commit and casually reusing the previous git commit command.
While this might be acceptable in personal repositories, it's somewhat unprofessional in collaborative repositories.
In my opinion, these commit records are unnecessary, represent bad habits, and can be completely avoided.
Fortunately, Git provides us with an elegant solution. If there's no need to generate a new commit, using git commit --amend can avoid this issue.
Use less git merge and more git rebase
For example:
Merge branch 'feature-A' of https://github.com/qiniu/reviewbot into feature-B
This indicates merging code from remote branch feature-A into feature-B. Here, feature-A is typically the main branch.
Such commit messages are unnecessary in your PR. PR commit messages should only contain useful information about the current changes.
Personally, I rarely use git merge, even for syncing remote branches, I generally use git rebase.
For example:
Besides the above benefits, git rebase helps maintain a very clean commit history in the main repository. Therefore, I strongly recommend using it.
Reviewbot's git commit check
Reviewbot is an open-source project by Qiniu Cloud, aimed at providing a self-hosted code review service for convenient code review/static analysis and implementation of custom engineering standards.
To better regulate these two behaviors, Reviewbot has added git commit check capability to verify if git commit records meet the standards.
If they don't comply with the standards, Reviewbot will notify you:
More git flow practices and tips
Of course, there are many practical techniques in git operations. I encourage interested individuals to explore them. I shared related content with students during the 1024 training camp:
Super Practical! Git Collaboration from a User's Perspective, Say Goodbye to Rote Memorization
The document includes video links for interested readers.
Finally, as professional engineers, we should always pursue excellence in engineering practices. Good commit records not only reflect personal professional quality but are also an important cornerstone for improving team collaboration efficiency.
Through proper use of git rebase and git commit --amend, we can maintain a clearer, more professional code submission history. This not only makes code review easier but also brings great convenience to subsequent code maintenance and issue tracking.
What do you think?
Top comments (0)