jeanbaptdzd commited on
Commit
8a92fc0
·
1 Parent(s): bedfb0c

test: Add PR template and test CodeRabbit integration

Browse files
.github/pull_request_template.md ADDED
@@ -0,0 +1,17 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ## Description
2
+ <!-- Describe your changes here -->
3
+
4
+ ## Type of Change
5
+ - [ ] Bug fix
6
+ - [ ] New feature
7
+ - [ ] Refactoring
8
+ - [ ] Documentation update
9
+
10
+ ## Testing
11
+ <!-- Describe how you tested your changes -->
12
+
13
+ ## Checklist
14
+ - [ ] Code follows project style guidelines
15
+ - [ ] Tests pass
16
+ - [ ] Documentation updated (if needed)
17
+
TEST_CODERABBIT.md ADDED
@@ -0,0 +1,40 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Testing CodeRabbit Integration
2
+
3
+ ## What to do:
4
+
5
+ 1. **Create a branch:**
6
+ ```bash
7
+ git checkout -b test-coderabbit-review
8
+ ```
9
+
10
+ 2. **Commit this test file:**
11
+ ```bash
12
+ git add TEST_CODERABBIT.md .github/pull_request_template.md
13
+ git commit -m "test: Add PR template and test CodeRabbit integration"
14
+ ```
15
+
16
+ 3. **Push and create PR:**
17
+ ```bash
18
+ git push origin test-coderabbit-review
19
+ ```
20
+ Then go to GitHub and create a Pull Request from `test-coderabbit-review` to `master`
21
+
22
+ 4. **Watch for CodeRabbit:**
23
+ - CodeRabbit should automatically comment on your PR
24
+ - It will review code quality, suggest improvements
25
+ - Check for CodeRabbit comments in the PR thread
26
+
27
+ ## What CodeRabbit will review:
28
+ - Code quality and best practices
29
+ - Potential bugs or security issues
30
+ - Performance optimizations
31
+ - Documentation completeness
32
+ - Test coverage
33
+
34
+ ## To test more thoroughly:
35
+ After this test, try creating a PR with:
36
+ - A small bug (see if it catches it)
37
+ - Missing error handling
38
+ - Performance issues
39
+ - Security concerns
40
+