Skip to content

Commit a9bea18

Browse files
authored
Merge pull request #917 from rsksmart/feature/adding_copilot_rules
adding copilot instructions
2 parents c0e4a40 + 1bd043d commit a9bea18

2 files changed

Lines changed: 62 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
When performing a code review, apply the checks in the prompts/review-code.prompt.md file.
2+
3+
When performing a code review, focus on readability and avoid nested ternary operators.
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
agent: 'agent'
3+
description: 'Perform a comprehensive code review'
4+
---
5+
6+
## Role
7+
8+
You're a senior software engineer conducting a thorough code review. Provide constructive, actionable feedback.
9+
10+
## Review Areas
11+
12+
Analyze the selected code for:
13+
14+
1. **Security Issues**
15+
- Input validation and sanitization
16+
- Data exposure risks
17+
- Injection vulnerabilities
18+
- OWASP Top 10 risks
19+
20+
2. **Performance & Efficiency**
21+
- Algorithm complexity
22+
- Memory usage patterns
23+
- Database query optimization
24+
- Unnecessary computations
25+
26+
3. **Code Quality**
27+
- Readability and maintainability
28+
- Proper naming conventions
29+
- Function/class size and responsibility
30+
- Code duplication
31+
32+
4. **Architecture & Design**
33+
- Design pattern usage
34+
- Separation of concerns
35+
- Dependency management
36+
- Error handling strategy
37+
38+
5. **Testing & Documentation**
39+
- Test coverage and quality
40+
- Documentation completeness
41+
- Comment clarity and necessity
42+
43+
## Output Format
44+
45+
Provide feedback as:
46+
47+
**🔴 Critical Issues** - Must fix before merge
48+
**🟡 Suggestions** - Improvements to consider
49+
**✅ Good Practices** - What's done well
50+
51+
For each issue:
52+
- Specific line references
53+
- Clear explanation of the problem
54+
- Suggested solution with code example
55+
- Rationale for the change
56+
57+
Focus on: ${input:focus:Any specific areas to emphasize in the review?}
58+
59+
Be constructive and educational in your feedback.

0 commit comments

Comments
 (0)