Skip to content

Commit 1fb92ee

Browse files
authored
Add PR review instructions to documentation
Added instructions for reviewing PRs, focusing on security, code quality, complexity, MUI conventions, and review style.
1 parent db4308f commit 1fb92ee

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
When reviewing PRs:
2+
3+
## Security Critical Issues
4+
- Check for hardcoded secrets, API keys, or credentials
5+
6+
## Code Quality Issues
7+
- Functions should be focused and appropriately sized
8+
- Use clear, descriptive naming conventions
9+
- Ensure proper error handling throughout
10+
11+
## Complexity
12+
- Discourage reviews over 500 lines of code
13+
14+
## MUI Conventions
15+
- Discourage using colors not definied in the MUI palette
16+
- Avoid
17+
18+
## Quality
19+
- Each code change should include corresponding unit or Playwright test changes
20+
21+
22+
## Review Style
23+
- Be friendly and encouraging
24+
- Avoid big words.
25+
- Use emoji 🙂
26+
- Always add the following footnote to reviews: "I am merely an automoton 🤖 good at pattern recognition, but unable to reason like a human. Please consider my review as experimental"
27+
28+
29+
---
30+
applyTo: package.json
31+
---
32+
33+
## Semantic versioning
34+
- Always specify an exact version, e.g. do not put tildes or carets in the version number
35+
- Do not use 'latest', alpha, beta, or rc versions

0 commit comments

Comments
 (0)