用途:按 Conventional Commits 规范生成 git 提交信息和 PR 描述,适用于提交代码、撰写 PR 标题、审查 git 历史等场景。格式为 <type>(<scope>): <subject>。
类型:feat(面向用户的新功能)、fix(缺陷修复)、docs(仅文档)、refactor(不改变行为的代码改动)、test(新增或修复测试)、chore(构建、依赖、工具)。
规则:subject 使用祈使语气,不加句号,不超过 50 字符;scope 可选,用于标明区域(如 auth、api、ui);破坏性变更在类型后加 !。示例:feat(auth): add Google OAuth login;fix(api): handle null user in profile endpoint;feat(api)!: change auth response format;chore(deps): upgrade Next.js to 15。应避免 "fix stuff"、"updates"、"WIP" 之类写法,改写为 fix(auth): resolve token refresh race condition。
PR 标题:与提交信息同格式,因为 PR 标题会成为 squash 提交信息。PR 正文建议包含三部分:## What(简要描述)、## Why(背景与动机)、## Testing(验证方式)。
分支命名:格式为 type/short-description,如 feat/oauth-login、fix/token-refresh、chore/upgrade-deps;可带工单编号,如 feat/PROJ-123-oauth-login、fix/PROJ-456-token-refresh。分支应保持短生命周期,合并后删除。
限制与未提供信息:资料未提供安装命令、调用方式、支持的平台、运行环境及收费情况,暂未提供;实际使用需结合所在地的 git 环境。