用途:为拉取请求(PR)自动生成符合 Conventional Commits 规范的标题,适用于用户要求生成 PR 标题或撰写 pull request 标题的场景。
标题格式:<type>[optional scope]: <description>。要求总长度不超过72个字符;使用祈使语气(如 add,而非 added 或 adds);不包含工单/issue 编号(这些应放在 PR 描述中);type 和 scope 使用小写。
类型(type):feat 新功能或增强;fix 缺陷修复;refactor 不改变行为的代码重构;chore 维护(依赖、配置、脚本);test 新增或更新测试;docs 文档变更;perf 性能改进;style 代码风格/格式(无逻辑变化);ci CI/CD 流水线变更;build 构建系统或外部依赖变更;revert 回滚此前的提交。
作用域(scope):可选,从被修改的主要文件夹或功能领域推断。可用的常见 scope 包括 analytics、transactions、wallet、ui、network、settings、permissions、tokens、nfts、swaps、bridge、staking、onboarding、confirmations、agents、e2e、deps、ramp、earn、perps、predict、notifications、accounts 等。应避免使用 app、src、components 等无法传达含义的泛化 scope;当改动跨越多个不相关领域时,应省略 scope。
使用步骤:先执行 git rev-parse --abbrev-ref HEAD 获取分支名;再执行 git diff main...HEAD 获取完整 diff;根据改动性质确定 type;从主要被修改的文件夹/功能推断 scope(不明确则省略);用祈使语气写一句简洁描述。
CI 校验:PR 标题由 amannn/action-semantic-pull-request GitHub Action(.github/workflows/pr-title-linter.yml)校验,不符合 Conventional Commits 格式的标题会导致 CI 失败。