规范你的 commit message 并且根据 commit 自动生成 CHANGELOG.md

前言

在软件开发中，版本控制系统是必不可少的工具，它可以帮助我们记录代码的变更，方便我们回滚到之前的版本，并且方便多人协作开发。Git 是目前最流行的版本控制系统之一，它提供了强大的功能和易用的操作界面。

在使用 Git 时，提交代码时需要输入提交信息（commit message），这非常重要，因为它可以帮助我们理解代码的变更内容。一个好的提交信息应该包含以下信息：

• 提交的类型（例如，新特性、bug 修复、文档更新等）
• 简短的（最多一行）
• 详细的（可以多行）
• 提交者姓名和邮箱地址
• 提交日期

规范你的 commit message

为了让你的 commit message 更加清晰、简洁、有意义，你可以遵循以下原则：

• 使用动词开头。例如，"修复了 bug"、"添加了新特性"、"更新了文档"。
• 使用现在时态。例如，"修复了 bug"，而不是 "修复 bug"。
• 使用祈使语气。例如，"添加了新特性"，而不是 "添加新特性"。
• 使用简短的描述。最多一行，不要超过 50 个字符。
• 使用详细的描述。可以多行，但每行不要超过 72 个字符。
• 使用提交者姓名和邮箱地址。这可以帮助你追踪提交者的身份。
• 使用提交日期。这可以帮助你追踪提交的时间。

根据 commit 自动生成 CHANGELOG.md

除了规范提交信息之外，你还可以使用一些自动化工具根据 commit 自动生成 CHANGELOG.md 文件。CHANGELOG.md 文件可以帮助你记录项目的变更历史，方便你查看项目的发展历程。

有很多工具可以帮助你根据 commit 自动生成 CHANGELOG.md 文件，例如：

• conventional-changelog
• semantic-release
• release-it

这些工具可以根据你的提交信息自动生成 CHANGELOG.md 文件，并且可以根据你的需要自定义生成规则。

结语

规范你的 commit message 并且根据 commit 自动生成 CHANGELOG.md 文件，可以帮助你更好地记录项目变更并保持项目透明度。这对于多人协作开发和日后的项目维护非常有帮助。