# ASDM Git Commit Message 规范 ## 格式 ``` ():

``` ## Type（必填） | Type | 说明 | |----------|--------------------------------------------| | feat | 新功能 | | fix | 修复 Bug | | docs | 文档变更 | | style | 代码格式调整（不影响功能运行） | | refactor | 重构（既非新增功能，也非修复 Bug） | | perf | 性能优化 | | test | 增加或修改测试 | | chore | 构建过程或辅助工具的变动 | | revert | 回滚提交 | | ci | CI/CD 配置变更 | | build | 构建系统或外部依赖变更 | ## Scope（推荐填写） Scope 用于说明 commit 影响的范围，建议使用模块名或功能区域名，例如： - `auth` — 认证模块 - `api` — API 层 - `ui` — UI 组件 - `config` — 配置相关 - `deps` — 依赖相关 - `infra` — 基础设施当改动涉及多个 scope 时，可使用 `*` 或省略。 ## Subject（必填） - 简短描述本次改动，不超过 50 个字符 - 使用祈使句（如 `add feature` 而非 `added feature`） - 结尾不加句号 - 中英文均可，但同一项目应保持一致 ## Body（可选） - 详细描述改动原因与内容 - 与 subject 拆开一行 - 可分多行 ## Footer（可选） - 关联 Issue：`Closes #123`、`Fixes #456` - 破坏性变更：`BREAKING CHANGE: <描述>` - 关联 MR/PR：`See MR #789` ## 示例 ### 新功能 ``` feat(auth): add OAuth2 login support Implement OAuth2 authentication flow for third-party login. Support Google and GitHub providers. Closes #101 ``` ### Bug 修复 ``` fix(api): fix null pointer in user query User query would throw NPE when userId is null. Add null check before querying. Fixes #234 ``` ### 重构 ``` refactor(ui): extract shared button component Move duplicate button logic from LoginPage and RegisterPage into a shared ButtonComponent. ``` ### 破坏性变更 ``` feat(api): change user API response format BREAKING CHANGE: user API now returns { data: user } instead of { user }. Update all consumers accordingly. Closes #55 ``` ### 回滚 ``` revert: feat(auth): add OAuth2 login support This reverts commit abc1234. ``` ## 检查清单 1. **type** 是否使用了规定的关键字？ 2. **scope** 是否准确描述了影响范围？ 3. **subject** 是否不超过 50 字符且为祈使句？ 4. 如有破坏性变更，是否标注了 `BREAKING CHANGE`？ 5. 是否关联了相关 Issue / MR？ ## 工具集成 ### git hook 校验建议在项目中配置 `commit-msg` hook，使用以下正则校验： ```regex ^(feat|fix|docs|style|refactor|perf|test|chore|revert|ci|build)(\(.+\))?: .{1,50} ``` ### commitizen 使用 [commitizen](https://github.com/commitizen/cz-cli) 交互式生成合规 commit message： ```bash npm install -g commitizen git cz ```