Edwin Salguero
chore: enterprise-grade project structure, robust .gitignore, and directory cleanup
9289e29
# π€ 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!** |