File size: 6,911 Bytes
184a5a6 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# π€ Cursor PR Review Guide for Dependabot PRs
## π― **Quick Start: Review All 12 Dependabot PRs**
### **Step 1: Run the Automated Review Script**
```bash
# Make the script executable
chmod +x review_dependabot_prs.sh
# Run the review workflow
./review_dependabot_prs.sh
```
This script will:
- β
Run local tests first
- β
Test Docker builds
- β
Open each PR in your browser
- β
Guide you through review decisions
- β
Log all decisions for tracking
## π **Cursor-Specific Review Workflow**
### **Method 1: Using Cursor's GitHub Integration**
#### **Open All PRs in Cursor:**
```bash
# In Cursor command palette (Cmd+Shift+P):
GitHub: View Pull Requests
```
#### **Review Each PR:**
1. **Select PR** from the list
2. **Review changes** in side-by-side diff
3. **Add comments** using Cursor's inline commenting
4. **Use AI assistance** for code review
5. **Approve or request changes**
### **Method 2: Direct PR URLs**
#### **EAName Repository PRs:**
```bash
# In Cursor command palette:
GitHub: Open Pull Request from URL
# Then paste these URLs one by one:
https://github.com/EAName/algorithmic_trading/pull/6
https://github.com/EAName/algorithmic_trading/pull/5
https://github.com/EAName/algorithmic_trading/pull/4
https://github.com/EAName/algorithmic_trading/pull/3
https://github.com/EAName/algorithmic_trading/pull/2
https://github.com/EAName/algorithmic_trading/pull/1
```
#### **ParallelLLC Repository PRs:**
```bash
# Same process for ParallelLLC:
https://github.com/ParallelLLC/algorithmic_trading/pull/6
https://github.com/ParallelLLC/algorithmic_trading/pull/5
https://github.com/ParallelLLC/algorithmic_trading/pull/4
https://github.com/ParallelLLC/algorithmic_trading/pull/3
https://github.com/ParallelLLC/algorithmic_trading/pull/2
https://github.com/ParallelLLC/algorithmic_trading/pull/1
```
## π **Review Checklist for Each PR**
### **Critical PRs (Review First):**
#### **1. Python 3.13 Update (PR #6)**
**Priority: HIGH**
```bash
# Check for breaking changes
- [ ] All dependencies compatible with Python 3.13
- [ ] No deprecated features used
- [ ] Performance impact minimal
- [ ] Trading logic unaffected
```
#### **2. Docker Action Updates (PRs #2, #4)**
**Priority: MEDIUM**
```bash
# Check CI/CD pipeline
- [ ] Docker builds still work
- [ ] Image size reasonable
- [ ] Security improvements
- [ ] No breaking changes
```
#### **3. GitHub Actions Updates (PRs #1, #3, #5)**
**Priority: LOW**
```bash
# Check workflow compatibility
- [ ] Actions still function
- [ ] No deprecated features
- [ ] Performance improvements
- [ ] Security enhancements
```
## π€ **Using Cursor's AI for PR Review**
### **AI-Assisted Review Commands:**
#### **1. Ask AI to Review Changes:**
```bash
# In Cursor chat:
"Review this PR for breaking changes and security issues"
```
#### **2. Check for Trading-Specific Issues:**
```bash
# In Cursor chat:
"Check if these dependency updates affect our trading algorithms or risk management"
```
#### **3. Validate CI/CD Pipeline:**
```bash
# In Cursor chat:
"Verify that these GitHub Actions updates won't break our CI/CD pipeline"
```
### **AI Review Prompts:**
#### **For Python 3.13 Update:**
```
"Review this Python 3.13 update for:
1. Breaking changes in our trading dependencies
2. Performance impact on our algorithms
3. Security improvements
4. Compatibility with our Docker setup"
```
#### **For GitHub Actions Updates:**
```
"Review these GitHub Actions updates for:
1. Workflow compatibility
2. Security improvements
3. Performance enhancements
4. Any deprecated features"
```
## π **Review Decision Matrix**
### **Approve If:**
- β
No breaking changes detected
- β
Tests pass locally
- β
Docker builds successfully
- β
Security improvements included
- β
Performance maintained or improved
### **Request Changes If:**
- β Breaking changes found
- β Tests fail
- β Docker build fails
- β Security vulnerabilities introduced
- β Performance degradation
### **Comment Only If:**
- π¬ Minor concerns that don't block approval
- π¬ Suggestions for future improvements
- π¬ Questions about implementation
- π¬ Documentation requests
## π‘οΈ **Trading-Specific Review Criteria**
### **Risk Management:**
- [ ] No changes to risk calculation logic
- [ ] Position limits still enforced
- [ ] Drawdown protection maintained
- [ ] Compliance requirements met
### **Performance:**
- [ ] Algorithm execution time unchanged
- [ ] Memory usage reasonable
- [ ] CPU utilization acceptable
- [ ] API response times maintained
### **Security:**
- [ ] No new vulnerabilities introduced
- [ ] API keys still secure
- [ ] Authentication mechanisms intact
- [ ] Data encryption maintained
## π― **Efficient Review Strategy**
### **Batch Review Approach:**
#### **Phase 1: Critical Updates (30 minutes)**
1. **Python 3.13 Update** - Test thoroughly
2. **Docker Updates** - Verify builds
3. **Security Updates** - Validate improvements
#### **Phase 2: Standard Updates (15 minutes)**
1. **GitHub Actions** - Quick compatibility check
2. **Minor Dependencies** - Standard review
3. **Documentation Updates** - Verify accuracy
#### **Phase 3: Approval (5 minutes)**
1. **Approve safe updates**
2. **Request changes for issues**
3. **Merge approved PRs**
## π **Review Template**
### **For Each PR, Use This Template:**
```markdown
## PR Review: [PR Title]
### β
What I Reviewed:
- [ ] Code changes
- [ ] Dependency updates
- [ ] Breaking changes
- [ ] Security implications
- [ ] Performance impact
- [ ] Local testing
- [ ] Docker build
### π Findings:
- **Breaking Changes**: [Yes/No]
- **Security Issues**: [Yes/No]
- **Performance Impact**: [None/Minor/Major]
- **Test Results**: [Pass/Fail]
### π¬ Comments:
[Add any specific comments or suggestions]
### β
Decision:
- [ ] **Approve** - Safe to merge
- [ ] **Request Changes** - Issues found
- [ ] **Comment Only** - Minor concerns
```
## π **Quick Commands for Cursor**
### **Keyboard Shortcuts:**
```bash
Cmd+Shift+P # Command palette
Cmd+Shift+G # Source control
Cmd+Enter # Submit review
Cmd+Shift+Enter # Approve PR
Cmd+/ # Toggle comment
```
### **Useful Commands:**
```bash
GitHub: View Pull Requests
GitHub: Open Pull Request from URL
GitHub: Review Pull Request
GitHub: Add Comment to Pull Request
```
## β
**Success Metrics**
### **Review Goals:**
- **Time**: Complete all 12 PRs in < 1 hour
- **Quality**: 100% of critical issues caught
- **Safety**: No breaking changes merged
- **Efficiency**: Use AI assistance for 80% of reviews
### **Quality Checklist:**
- [ ] All PRs reviewed within 24 hours
- [ ] No critical issues missed
- [ ] All approved PRs pass CI/CD
- [ ] Documentation updated as needed
- [ ] Team notified of any issues
---
**Ready to start? Run `./review_dependabot_prs.sh` to begin the automated review workflow!** |