Conventional Commits are a lightweight commit message format that makes it easier to use tools like Git and GitHub for analyzing, reporting, and managing contributions to a project.

Key Points

  • Format: Each commit message follows a specific format, making it easy to parse and extract information.
  • Subject Line: Should start with a verb and describe the commit.
  • Body: Optional, can include more detail about the commit.
  • Footer: Optional, can include references to issues or other important information.

Example

fix: fix typo in documentation

This commit fixes a typo in the documentation.

Benefits

  • Better Analysis: Tools can easily analyze and report on contributions.
  • Easier Review: Reviewers can quickly understand the purpose of each commit.
  • Improved Workflow: Streamlines the process of managing contributions.

Learn More

For more information on Conventional Commits, please visit the official documentation.

[center] Git Commit Message Format [center]