job51-gitlab-cr-node-skill-prompt-optimize 1.3.1 → 1.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/mr-review-template.md +39 -15
- package/package.json +1 -1
package/mr-review-template.md
CHANGED
|
@@ -7,32 +7,39 @@
|
|
|
7
7
|
4. 不要添油加醋,仔细辨别代码的增删改;
|
|
8
8
|
5. 使用当前系统时间填充 `[当前时间]`,并根据实际变更内容计算 `[文件数量]`;
|
|
9
9
|
6. 所有占位符(如 `[具体问题描述]`)必须被真实内容替换,不可保留;
|
|
10
|
+
> - **修改建议中的代码示例**:
|
|
11
|
+
> - 错误代码:必须是**变更后实际存在的代码**(从变更内容中选取有问题的当前代码)
|
|
12
|
+
> - 正确示例代码:必须是**修复后的建议代码**
|
|
13
|
+
> - 不得将已删除的代码(- 开头的行)作为错误代码展示
|
|
10
14
|
7. 若无某类问题(如无严重问题),则**完全省略该部分**(例如不输出“🔴 严重问题”标题);
|
|
11
15
|
8. 若当前审核的代码块中相同级别问题有不止一个,在对应级别的标题下按原代码顺序依次展示,如存在两个严重问题时,按其在代码中的原有顺序在严重问题标题下依次展示;
|
|
12
16
|
9. 严重问题的定义如下
|
|
13
17
|
> - 存在安全漏洞(如 SQL 注入、命令注入、敏感信息泄露)
|
|
14
18
|
> - 可能导致数据丢失/损坏/不一致
|
|
15
|
-
> -
|
|
19
|
+
> - 引发任何**运行时异常**
|
|
16
20
|
**典型触发场景**:
|
|
17
|
-
`Boolean` 包装类直接用于条件判断:`if (booleanFlag)` 当 `booleanFlag` 为 `null` 时自动拆箱抛出
|
|
18
|
-
`Integer/Long` 等包装类赋值给基础类型:`int count = integerCount` 当 `integerCount` 为 `null` 时自动拆箱抛出
|
|
19
|
-
方法链式调用未判空:`user.getProfile().getName()` 当 `getProfile()` 返回 `null` 时抛出
|
|
20
|
-
集合/数组未判空直接遍历:`for (Item item : list)` 当 `list` 为 `null` 时抛出
|
|
21
|
+
`Boolean` 包装类直接用于条件判断:`if (booleanFlag)` 当 `booleanFlag` 为 `null` 时自动拆箱抛出 `NullPointerException`
|
|
22
|
+
`Integer/Long` 等包装类赋值给基础类型:`int count = integerCount` 当 `integerCount` 为 `null` 时自动拆箱抛出 `NullPointerException`
|
|
23
|
+
方法链式调用未判空:`user.getProfile().getName()` 当 `getProfile()` 返回 `null` 时抛出 `NullPointerException`
|
|
24
|
+
集合/数组未判空直接遍历:`for (Item item : list)` 或 `list.stream()` 当 `list` 为 `null` 时抛出 `NullPointerException`
|
|
25
|
+
集合索引越界:`list.get(index)` 当 `index >= list.size()` 时抛出 `IndexOutOfBoundsException`
|
|
26
|
+
类型转换错误:当 强制转换`obj`,但其实际类型不匹配时抛出 `ClassCastException`
|
|
21
27
|
`Optional` 误用:`optional.get()` 未先调用 `isPresent()` 或直接使用 `ifPresent()`
|
|
22
28
|
> - 引发资源泄漏、死锁等运行时崩溃风险
|
|
23
29
|
> - 违反事务一致性或并发安全原则
|
|
24
30
|
> - 导致核心功能失效或产生错误业务结果
|
|
25
31
|
> - 引入构建失败、测试失败或高危依赖漏洞
|
|
26
|
-
9.
|
|
32
|
+
9. 警告问题的定义如下(优先级低于严重问题,不会造成立即崩溃或数据丢失,但存在隐患)
|
|
27
33
|
> - 代码可读性差(如魔法数字、命名不规范、缺少必要注释)
|
|
28
34
|
> - 性能潜在问题(如低效算法、不必要的数据库查询、内存使用不当)
|
|
29
|
-
|
|
35
|
+
> - **注意**:若性能问题与严重问题行号重叠,仅保留严重问题
|
|
36
|
+
> - 边界条件处理不完善(如空集合、极端值未妥善处理)
|
|
37
|
+
> - **注意**:若边界条件问题可能导致运行时异常,应归类为严重问题
|
|
30
38
|
> - 异常处理不完善(如捕获异常未记录或吞掉异常)
|
|
31
39
|
> - 资源使用不规范(如未关闭资源但无泄漏风险、连接池配置不当)
|
|
32
40
|
> - 代码重复或违反 DRY 原则
|
|
33
41
|
> - 类型安全警告(如原始类型使用、unchecked 转换)
|
|
34
|
-
> -
|
|
35
|
-
> - **强制规则**:同一行号的问题不得同时出现在严重问题和警告中
|
|
42
|
+
> - **输出前检查**:若某行号范围的问题已在严重问题中报告,警告中**禁止**再出现该行号的任何条目
|
|
36
43
|
10. **问题描述准确性规则**:
|
|
37
44
|
> - 必须准确识别代码变更引入的实际风险,不得以次要风险(如性能影响)掩盖主要风险(如空指针异常)
|
|
38
45
|
> - 示例:删除 `CollectionUtils.isEmpty(jobids)` 空检查后,若后续直接调用 `jobids.stream()`,实际风险是 **NPE** 而非"不必要的 Redis 操作"或"性能影响"
|
|
@@ -46,12 +53,13 @@
|
|
|
46
53
|
> - 示例:若某一个代码块同时存在"集合未判空"和"Boolean 拆箱",两者均为严重问题,应在严重问题标题下并列展示
|
|
47
54
|
12. 最终输出必须以 `<REPORT>` 开始,以 `</REPORT>` 结束,确保内容可被程序安全提取。
|
|
48
55
|
13. 需要分析的变更内容位于下方<CHANGE_CONTENT>标签内。
|
|
49
|
-
14. 变更内容的行信息位于下方<LINE_INFO
|
|
50
|
-
|
|
56
|
+
14. 变更内容的行信息位于下方<LINE_INFO>标签内,里面的内容格式为:"@@ -84,9 +84,11 @@ public class UserCompetitiveAnalyseLogServiceImpl extends ServiceImpl<UserCompet",使用变更后区域计算新代码块的起始行和结束行。
|
|
57
|
+
**行号计算规范**:
|
|
51
58
|
> - 行号必须基于 <LINE_INFO> 中的变更后行号计算(+ 号后的数字)
|
|
52
59
|
> - 格式 "@@ -84,9 +84,11 @@" 表示变更后代码从 84 行开始,共 11 行
|
|
53
60
|
> - 问题行号必须是变更后代码的实际行号,不得引用变更前行号
|
|
54
61
|
> - 若问题涉及多行,行号范围应覆盖完整问题代码块(如 84-93)
|
|
62
|
+
> - **重要**:行号对应的代码必须是变更后保留的代码,不得指向已删除的代码行
|
|
55
63
|
15. `<REPORT>`标签的每一个标题内都有两个问题块,这里只是进行示例,表示有不止一个问题时应该怎么展示,不是说每一个标题下必须有两个问题,具体问题的数量有review的结果决定,按原始代码块中对应代码的顺序依次展示即可
|
|
56
64
|
16. **输出前必须执行去重检查**:
|
|
57
65
|
> - **第一步:收集所有问题的文件及行号信息**
|
|
@@ -62,12 +70,28 @@
|
|
|
62
70
|
> - **判定为同一变更的标准**(满足任一即视为同一问题):
|
|
63
71
|
> - 文件相同且行号完全相同
|
|
64
72
|
> - 文件相同且行号范围重叠超过 50%
|
|
65
|
-
> -
|
|
66
|
-
>
|
|
67
|
-
|
|
68
|
-
|
|
73
|
+
> - 指向同一处代码修改(如同样删除 `CollectionUtils.isEmpty()` 判断)
|
|
74
|
+
> - 问题描述存在因果关系(如"运行时异常"是"代码健壮性不足"的具体表现)
|
|
75
|
+
> - **示例**:若 87-93 行同时被识别为:
|
|
76
|
+
> - 严重问题:"移除 jobids 空值检查可能导致空指针异常"
|
|
77
|
+
> - 警告:"移除 jobids 空值检查可能导致后续不必要的 Redis 操作"
|
|
69
78
|
> - **处理**:仅保留严重问题,**强制删除**警告条目
|
|
70
79
|
> - **最终验证**:生成报告前必须确认严重问题、警告、优化建议三部分中**不存在任何行号重叠的条目**,如有重叠必须删除低级别条目
|
|
80
|
+
17. **代码变更方向识别规则**:
|
|
81
|
+
> - **变更内容格式说明**:
|
|
82
|
+
> - 以 `-` 开头的行表示**已删除的代码**,不应作为当前代码审查
|
|
83
|
+
> - 以 `+` 开头的行表示**新增的代码**,是审查的重点
|
|
84
|
+
> - 以空格开头的行表示**未变更的上下文代码**,仅作参考
|
|
85
|
+
> - **审查对象**:
|
|
86
|
+
> - 仅审查**变更后保留的代码**(新增代码 + 未删除的原有代码)
|
|
87
|
+
> - 不得将已删除的代码作为"错误代码"展示
|
|
88
|
+
> - **错误代码示例的选取**:
|
|
89
|
+
> - 应展示变更后实际存在的有问题代码
|
|
90
|
+
> - 若问题是由于删除某行代码导致的(如删除空检查导致 NPE),错误代码应展示**删除后的当前代码**,而非已删除的代码
|
|
91
|
+
> - **示例**:
|
|
92
|
+
> - 若删除了 `if (CollectionUtils.isEmpty(jobids)) { return; }`
|
|
93
|
+
> - 错误代码应展示删除后直接调用 `jobids.stream()` 的代码
|
|
94
|
+
> - 不得展示已删除的 `if (CollectionUtils.isEmpty(jobids))` 作为错误代码
|
|
71
95
|
|
|
72
96
|
<REPORT>
|
|
73
97
|
## 🤖 AI代码审查结果
|