---

name: commit description: 遵循Terrae规范创建标准化git提交 allowed-tools: Bash(git *)

提交技能

遵循Terrae规范创建标准化的git提交。

说明

1. 检查当前状态

   • 运行 git status 查看已更改的文件
   • 运行 git diff 查看实际更改内容

2. 与用户一起审查更改

   • 总结哪些文件被更改
   • 解释更改的性质（新功能、错误修复、重构等）
   • 询问用户是否要继续提交

3. 暂存文件

   • 按名称暂存特定文件（避免使用 git add -A 或 git add .）
   • 切勿暂存敏感文件（.env、凭据等）

4. 提交消息格式 遵循约定式提交：

   type(scope): description
   

   类型：

   • feat：新功能
   • fix：错误修复
   • docs：文档更改
   • style：格式化，无代码更改
   • refactor：代码重构
   • test：添加或更新测试
   • chore：维护任务

   示例：

   • feat(marker): 添加旋转支持
   • fix(popup): 防止卸载时的内存泄漏
   • docs(readme): 更新安装说明

5. 新组件约定

   提交新组件时，按以下顺序拆分为3个独立的提交：

   1. feat(map): 添加 {component} 组件 — 源文件 (src/registry/map/{slug}.tsx)
   2. feat(docs): 添加 {component} 示例组件 — 所有示例文件 (src/app/docs/_components/examples/{slug}-*.tsx)
   3. feat(docs): 添加 {component} 文档页面 — 文档页面 (src/app/docs/{slug}/page.tsx)

   共享文件修改（侧边栏、组件页面、更新日志、registry.json、导出文件）应单独提交，因为它们通常包含多个组件的更改。

6. 重要规则

   • 不要添加 Co-Authored-By 行
   • 未经用户批准不要提交
   • 除非明确要求，否则不要使用 --amend
   • 除非明确要求，否则不要推送
   • 保持提交消息简洁（少于72个字符）

7. 创建提交

   git commit -m "type(scope): description"
   

8. 验证

   • 运行 git status 确认提交成功
   • 向用户显示提交哈希值