首页/开发/Git 与协作速查/Conventional scope 范围写法
协作与代码评审75 条

Conventional scope 范围写法

scope 用括号标注影响范围(模块、包、目录),面向单仓多模块项目尤其有用;范围名建议与目录/包名一致,便于按范围筛选提交。

Git 与协作速查开发更新于 2026-10-12
语法<type>(<scope>): <描述>
取值建议与模块名/包名/目录名保持一致
省略全局性改动可省略 scope

常用示例

常用示例
git commit -m 'fix(auth): 修正 token 过期判断'
git commit -m 'feat(web): 增加暗色主题切换'
# 按范围检索提交
git log --oneline --grep '^(feat|fix)(\(auth\))'
scope 不必细到文件级,粒度以「能定位责任模块」为准;全仓级改动直接省略。

易错点

  • scope 命名随意(auth / Auth / 认证混用)会让检索与过滤失效,约定统一小写英文或团队词典
  • 多层嵌套 scope(如 core/auth/token)可读性差,建议控制在单层

数据来源与参考

  • Conventional Commits 1.0.0 规范(scope 章节)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌