GPT中文小秘书挑几下就能开工
我积分

起草代码规范和CR清单

关于「起草代码规范和CR清单」:能拿到什么、要点选什么、怎么办

规范、CR清单、分支说明一次起草齐。代码规范与CR清单是给技术团队统一评审口径的文档;在 GPT中文网点选几项,能直接拿到规范、清单和分支说明。

能拿到什么

  • 推荐:代码规范文档(含CR检查清单)(分章节:命名、注释、提交规范、CR检查项表格、分支策略与合并规则)

要你点选的几项

技术栈、团队人数、分支模式、评审重点、问题分级、上传规范材料、典型问题。多数点一下就行,没选的按常见情况替你定,交付时说清哪几项是按默认的。

怎么办

  1. 上传现有规范和历史评审意见
  2. 勾选评审重点与问题分级方式
  3. 确认分支模式和合并规则
  4. 生成规范文档、CR清单和分支说明
  5. 持证/负责人核对后下发团队

别人还这样说

  • 帮我照着现有规范和历史评审意见,起一份代码规范和CR检查清单
  • 我们团队CR老抓不住重点,帮我列一份评审时要看的清单
直接说你要办的事。下面是别人怎么办的,点任何一项就换成你自己的。左边是别人怎么办的,右边是你的,点一项就开始改。
示范 · 别人这样说

「把我们的Git分支怎么开、怎么合写清楚,顺便配个CR清单」

按示范选好的 点一项就变成你的

你的成品会在这里出现
示例成品 · 不是你的按示范写的,看个样子
示例:代码规范与CR清单(示意) 一、适用范围 本文档适用于某某公司研发一组,技术栈 Java + Spring Boot + Vue,团队 8 人,当前采用 GitHub Flow。 二、命名与结构 类名用大驼峰;方法名用小驼峰;常量全大写下划线分隔。包结构按 模块/分层 两级,禁止跨层直接调用 DAO。 三、提交信息 格式:type(scope): 描述。type 取 feat/fix/refactor/test/docs/chore。示例:fix(order): 修复优惠券重复抵扣。 四、CR检查清单 检查项 | 级别 | 说明 命名是否统一 | 建议 | 对照本文第二节 是否有空指针风险 | 阻塞 | 外部入参与返回值需判空 异常是否被吞掉 | 阻塞 | catch 后不得仅打日志 单测是否覆盖新增分支 | 建议 | 新增逻辑主路径至少一条 SQL 是否有索引与注入风险 | 阻塞 | 拼接 SQL 一律不通过 日志是否含敏感字段 | 阻塞 | 手机号、证件号需脱敏 依赖版本是否锁定 | 建议 | 新增依赖写进清单 五、问题分级 阻塞:必须改完才能合入;建议:可先记录,下个迭代处理。 六、分支策略 主分支 main 保持可发布;功能分支 feature/工单号-简述,从 main 拉出;合并需 1 名及以上评审通过,CI 通过后合入;发布用 tag,版本号形如 v1.2.0。 七、评审流程 提 MR 附变更说明与自测记录;评审人按清单逐项勾选;阻塞项清零后合入。 结论由团队负责人核对团队现状后才能发布使用。

GPT中文 也可能出错,成品请自己核对关键数字和事实。条款 · 隐私