Comet：使用约定式提交的CLI工具

1. 项目介绍

Comet是一个简单的命令行工具，旨在帮助开发者使用约定式提交（conventional commits）进行git提交。约定式提交提供了一种标准化、易于理解的提交信息格式，有助于项目的维护和文档化。

2. 项目快速启动

在开始使用Comet之前，确保您的系统已经安装了Go语言环境，版本至少为1.17+。

安装Comet

打开终端，运行以下命令安装Comet：

go install github.com/liamg/comet@latest

安装完成后，您可以在任何位置使用comet命令，它将替代git commit。

使用Comet

使用Comet提交信息时，您可以像平常一样添加任何git commit支持的flag。以下是一个基本的提交示例：

comet -m "feat: 添加了一个新特性"

如果您想要自定义Comet的行为，可以在仓库的根目录或家目录下创建一个.comet.json文件。

{
  "signOffCommits": false,
  "prefixes": [
    {
      "title": "feat",
      "description": "一个新特性"
    },
    {
      "title": "fix",
      "description": "一个bug修复"
    },
    {
      "title": "bug",
      "description": "引入一个bug"
    }
  ]
}

3. 应用案例和最佳实践

提交信息格式

约定式提交信息通常包括以下结构：

• 类型（Type）：描述本次提交的类别（如feat、fix）。
• 描述（Description）：详细描述本次更改的内容。
• scope（可选）：影响的范围。
• issue（可选）：关联的issue编号。

例如：

comet -m "fix: 修复了登录按钮的点击事件处理 #123"

代码审查

在使用Comet进行提交后，确保您的代码遵循项目的代码标准和风格指南。这对于维护代码质量和一致性至关重要。

项目维护

定期检查和更新项目的依赖项，确保它们是最新的，并与Comet兼容。

4. 典型生态项目

Comet作为约定式提交的工具，可以与许多其他开源项目配合使用，例如：

• Commitizen：一个帮助撰写规范commit信息的命令行工具。
• Conventional Changelog：自动从commit信息生成CHANGELOG。
• semantic-release：自动化版本发布和changelog生成的工具。

通过整合这些工具，您可以构建一个高效的代码提交和发布工作流程。