3.9 KiB
3.9 KiB
name, description
| name | description |
|---|---|
| 提交代码 | 提交全部内容并推送到远程仓库（不检查路径） |
用户输入
$ARGUMENTS
执行前必须处理用户输入（非空时）
输出
-
分析本次需要提交的内容，按照Git 提交规范整理提交消息
-
提交全部内容并推送到远程仓库
-
使用以下格式输出
项目根目录： xxx
工作目录： xxx
本地分支： xxx
远程分支： xxx
远程地址： xxx
用户输入： $ARGUMENTS
提交哈希： xxx
提交时间： yyyy-MM-dd HH:MM:SS
提交日志：
{git日志}
Git 提交规范
遵循 Conventional Commits 标准，结合项目特定需求制定以下提交规范：
提交消息格式
<类型>(<作用域>): <描述>
[可选正文]
[可选脚注]
提交类型
主要类型：
- 功能 (
feat): 添加新功能或增强现有功能 - 修复 (
fix): 修复 bug 或错误行为 - 维护 (
chore): 维护性任务（依赖更新、配置修改等） - 文档 (
docs): 文档更新、README、注释等 - 重构 (
refactor): 代码重构（不改变外部行为） - 测试 (
test): 添加、修改或修复测试代码 - 格式 (
style): 代码格式化、空白调整等 - 性能 (
perf): 性能优化改进 - 构建 (
build): 构建系统、工具链变更
扩展类型：
- 安全 (
sec): 安全相关修复或改进 - 依赖 (
deps): 依赖包更新或添加 - 清理 (
clean): 删除无用代码或文件 - 优化 (
perf): 性能或代码优化改进 - 配置 (
config): 配置文件修改 - 规格 (
spec): speckit 规格文档更新
特殊类型：
- 合并 (
merge): 分支合并 - 进行 (
wip): 工作进行中（开发中的临时提交） - 回滚 (
revert): 回滚之前的提交 - 发布 (
release): 发布版本标签
格式要求
标题行规则：
- 使用祈使语气（"添加" 而不是 "添加了"）
- 长度不超过 50 个字符
- 类型后使用冒号和空格分隔：
功能: 添加用户认证 - 可指定作用域：
功能(auth): 添加 JWT 验证
正文内容（可选）：
- 标题与正文之间留空行
- 说明"做什么"和"为什么"，而非"怎么做"
- 每行不超过 72 个字符
- 使用项目符号列出多个改动
脚注信息（可选）：
- 标记破坏性变更：
破坏性变更: 详细说明 - 关联 issue：
关联: #123或解决: #456 - 标记不兼容变更：
不兼容: API 接口参数调整
提交示例
基础提交
功能: 添加用户登录功能
修复: 修复内存泄漏问题
文档: 更新 API 文档
维护: 更新依赖版本
带作用域的提交
功能(api): 添加用户认证接口
功能(ui): 添加登录页面组件
修复(服务端): 修复数据库连接超时
测试(集成): 添加端到端测试用例
详细描述的提交
功能: 实现实时消息推送
- 添加 WebSocket 连接管理
- 实现消息广播机制
- 添加离线消息存储
- 支持消息确认机制
影响范围：
- 前端消息组件更新
- 服务端路由扩展
- 数据库表结构变更
关联: #89
Claude Code 提交行为规范
重要：Git 提交消息格式要求
-
禁止在提交消息中添加以下内容：
🤖 Generated with [Claude Code](https://claude.com/claude-code)Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>- 任何类似的 AI 工具签名或标识
-
原因：保持 Git 提交历史的简洁性和专业性，避免冗余的元数据
-
正确示例：
文档: 添加用户认证功能 - 添加 JWT 验证中间件 - 实现登录登出接口 - 添加权限校验逻辑 -
错误示例（不要这样做）：
文档: 添加用户认证功能 - 添加 JWT 验证中间件 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>