Introduction #
In any version control software, proper commit messages are crucial for team collaboration and code maintenance. Git, as the most popular distributed version control system, benefits greatly from standardized commit messages. They help team members better understand the code history, speed up code reviews, and automate changelog generation. This article introduces some common Git commit message conventions.
Importance of Git Commit Conventions #
- Improved Readability: Clear commit messages allow team members to quickly understand the purpose and changes of a commit.
- Ease of Tracking: Standardized commits make it easier to search for specific changes in the history.
- Support for Automation Tools: Standardized commit messages can be used by various tools, such as automatically generating CHANGELOGs or analyzing code changes through scripts.
Common Format of Git Commit Messages #
A standardized Git commit message typically includes the following parts:
- Type: The type of the commit, such as fixing a bug (
fix) or adding a new feature (feat). - Scope: (Optional) The scope of the changes, such as a component or a module.
- Subject: A brief description of the commit, not exceeding 50 characters.
- Body: (Optional) A more detailed description, which can span multiple lines.
- Footer: (Optional) Descriptions of related issues or breaking changes.
For example:
feat(login): add the remember me button
- Add a "remember me" checkbox in the login form
- Save the login state to local storage when checked
Closes #123Common Commit Types #
Below are some common commit types and their meanings:
- feat: New feature
- fix: Bug fix
- docs: Documentation
- style: Formatting (changes that do not affect code execution)
- refactor: Code refactoring (neither adding a feature nor fixing a bug)
- test: Adding tests
- chore: Changes to the build process or auxiliary tools
Reference Articles #
When defining your own Git commit conventions, you can refer to the following articles and resources:
- Conventional Commits
- AngularJS Git Commit Message Conventions
- Semantic Versioning Specification (SemVer)
The above outlines the basic Git commit conventions and some recommendations. You can customize your commit conventions based on your team’s specific needs.