Skip to content

Commit 2ec8d70

Browse files
authored
chore: list very important review guidelines, including the ruleID requirement
1 parent 8646f57 commit 2ec8d70

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

contributingGuides/review/RULES.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# ✅ AI Code Review Rules
22

33
These rules are used to conduct structured code reviews on pull request diffs.
4-
Very important: in your review, make sure you include a separate comment for every rule violation.
54

65
Each rule includes:
76
- A unique **Rule ID**
87
- **Pass/Fail condition**
98
- **Reasoning**: Technical explanation of why the rule is important
109
- Examples of good and bad usage
1110

11+
Very important:
12+
- Make sure you include a separate comment for every rule violation
13+
- Every comment has to reference a **Rule ID** it violates
14+
1215
---
1316

1417
## Performance Rules

0 commit comments

Comments
 (0)