---
alwaysApply: true
scene: git_message
---

# Git 提交信息生成规则

## 语言
- **必须使用中文**生成提交信息(subject 和 body 全部使用中文)
- 专有名词、类名、函数名、API 名称等可保留英文
- 标点符号使用中文全角符号(,。:;)

## 格式规范
采用 Conventional Commits 规范,格式如下:
```
<type>(<scope>): <subject>
```
其中:
- `<type>` 是提交类型,可选值为 `feat``fix``docs``style``refactor``test``chore`
- `<scope>` 是影响的范围,可选
- `<subject>` 是提交的描述,必须使用中文

## 提交时机
- 每次修改代码后,都必须自动提交到 Git 仓库
- 提交时,必须包含提交信息
- 提交信息必须符合格式规范

## 推送远程仓库
- 每次提交到本地仓库后,都必须自动推送到远程仓库

## 仓库说明
- server目录下的是server后端仓库
- uniapp目录下的是uniapp前端仓库
- 根目录不存在git仓库,不要在项目根目录做任何的git操作,包括初始化、提交、拉取、推送等
- 提交到的仓库必须是主分支(master)

## 前端构建说明
- 前端项目推送远程仓库后自动构建h5版本
- 构建命令:npm run build:h5:prod
- 构建完成后提醒用户手动复制构建产物到server目录下的public目录并提交推送server仓库到远程仓库
- 提交推送server仓库到远程仓库后,webhook会自动触发后端项目的代码拉取部署到服务器上

所有评论
加载评论 ...
发表评论