About conventional-committer
conventional-committer is a skill for developers that stages changes, prepares Conventional Commit messages, and runs git commits. It adds checks for worktree context, change size, task scope, and required audits before committing.
Key features
- 01Stage changed files
- 02Generate Conventional Commit messages
- 03Check worktree and branch context
- 04Limit commit scope and file count
- 05Require typecheck, lint, and tests before commit
Use cases
- 01Commit a focused feature or fix
- 02Check repository status before staging
- 03Prepare a commit after code audits pass
Install
Copy the command and run it in a terminal.
$
npx skills add https:/After installing, type/conventional-committerin Claude Code to confirm it loaded.
Details
From the project READMEConventional Committer Skill (规范提交技能)
- 暂存 (Staging): 将修改后的文件添加到 git 暂存区。
- 消息生成: 创建遵循
type(scope): description格式的提交消息 (例如:feat(auth): add login page)。 - 提交 (Committing): 执行
git commit。
指令 (Instructions)
- Worktree 感知: 提交前确认当前所在目录（如
../momei-dev），确保提交是在正确的分支和上下文中进行的。 - 规范对齐: 在提交前必须确认遵循 开发规范。
- 规模校验: 强制检查本次改动的文件数量。原则上文件数 不要超过 10 个；对应的功能点必须单一。
- 任务关联: 每次提交应且仅应关联 待办事项 (Todo) 中的一个原子条目。
- 提交前检查: 在执行任何 git 提交操作前，确认
@code-auditor已经通过了pnpm typecheck,pnpm lint和必要的定向测试。 - 验证状态: 检查
git status查看哪些内容需要暂存。 - 生成消息: 分析更改以确定
type(feat, fix, docs, style, refactor, test, perf, build, ci, chore, revert),scope(可选, 例如: 组件名, 模块) 和description。消息描述统一使用中文。 - 提交: 运行
git commit -m "..."。 - 验证: 确保消息符合
commitlint.config.ts。
使用示例 (Usage Example)
输入: "提交新的用户资料功能。"
动作: git add ., 分析变更, 生成消息 feat(user): 实现带有头像上传功能的用户个人资料页面, git commit。
Comments
Markdown supported