根据 git 变更生成符合 Sa-Token 项目风格的 commit message。遵循 Conventional Commits 格式,以中文为主。当用户要求生成提交信息、写 commit message、或根据变更生成提交说明时使用。
根据当前 git 变更(staged 或 unstaged),生成符合 Sa-Token 项目规范的 commit message。
git status
git diff --staged
git diff
必须包含的变更范围:
git diff --stagedgit diff 查看工作区修改git status 中的 Untracked files 也要纳入分析,生成 commit message 时需一并考虑若存在未跟踪的新增文件(如新 skill、新配置等),应在 message 中体现,或给出「包含全部变更」与「仅已修改文件」两种方案供用户选择。
根据变更内容选择 type 前缀:
| type | 适用场景 |
|---|---|
| feat | 新增功能、新模块、新插件 |
| fix | 修复 bug、修正错误 |
| refactor | 重构、优化结构、重命名、移除冗余 |
| perf | 性能优化(与 refactor 区分:侧重性能) |
| docs | 文档更新、README、错别字、同步链接 |
| style | 代码格式调整(缩进、空格等,不影响逻辑) |
| chore | 构建配置、.gitignore、注释修复、依赖更新 |
| test | 单元测试、测试用例 |
| demo | 示例项目、demo 相关 |
| memo | 备忘录、内部记录 |
| revert | 回滚某次提交 |
| AI | AI 创建的 skill、规则等 |
基础格式:type: 简短描述 或 type(scope): 简短描述
scope 可选:涉及特定模块时使用,如 feat(sign)、fix(oauth2)、refactor(dependencies)。
规范:
StrFormatter、sa-token-jackson3)可选 Body/Footer(重要变更时):
Fixes #123 或 merge: [pr N](url)直接输出可复制的 commit message。若有多条合理方案,可给出 1~2 个备选。
简单提交(常用):