git提交规范

提交模板可以帮助统一提交信息的格式。比如，使用 Conventional Commits 规范。

步骤：

1. 创建一个提交模板文件，例如 git-commit-template.txt，内容如下：

   # 类型(type): 描述简短说明
   
   # 类型必须为以下之一:
   #   feat:     新功能
   #   fix:      修复Bug
   #   docs:     文档更新
   #   style:    代码格式化
   #   refactor: 代码重构
   #   test:     测试用例
   #   chore:    构建或辅助工具变动
   
   # 可选(scope): 影响范围，例如模块或文件
   
   # 如果这是一个破坏性变更，请添加 BREAKING CHANGE 声明:
   # BREAKING CHANGE: 描述变更
   
   # 详细描述(可选):
   # 描述变更的背景、原因和解决方案
   
   # 关闭的相关Issue(可选):
   # Closes #Issue编号
   

2. 在终端中运行以下命令，将模板文件与 Git 关联：

   git config --global commit.template /path/to/git-commit-template.txt
   

提交示例

类型：feat

• 描述：添加了新功能。

feat(user): 添加用户注册功能

在用户模块中新增了注册功能，支持用户通过邮箱和密码注册。

---

类型：fix

• 描述：修复了 Bug。

fix(auth): 修复登录页面密码输入框无法聚焦的问题

登录页面的密码输入框在某些浏览器中无法自动聚焦，已修复此问题。

---

类型：docs

• 描述：更新了文档。

docs(readme): 更新项目 README 文件

添加了项目安装步骤和使用说明，方便开发者快速上手。

---

类型：style

• 描述：代码样式调整，不涉及功能变更。

style(home): 格式化首页代码

使用 Prettier 对首页代码进行了格式化，统一缩进和换行符。

---

类型：refactor

• 描述：代码重构，不涉及功能变更。

refactor(api): 重构用户 API 模块

将用户 API 模块拆分为多个子模块，提高代码可读性和可维护性。

---

类型：test

• 描述：添加或修改测试用例。

test(user): 添加用户登录功能测试用例

为登录功能添加了单元测试，覆盖了正常登录、密码错误和用户不存在的情况。

---

类型：chore

• 描述：构建工具或依赖项更新。

chore(deps): 更新依赖包版本

更新了项目中的依赖包，修复了已知的安全漏洞。

---

类型：BREAKING CHANGE

• 描述：涉及重大变更的提交。

feat(user): 重构用户认证逻辑

重构了用户认证模块，移除了旧的认证方式，改为使用 JWT 认证。

BREAKING CHANGE: 旧版本的用户认证功能将不再兼容，请升级到最新版本。