Team Ai
Modelpublic

ParallelLLC/algorithmic_trading

sourceHugging Faceapache-2.0updated 2mo agoView on Hugging Face
27likes32downloads
CURSOR_PR_REVIEW_GUIDE.md269 linesDownload Raw Back to scripts
1# ๐Ÿค– Cursor PR Review Guide for Dependabot PRs2 3## ๐ŸŽฏ **Quick Start: Review All 12 Dependabot PRs**4 5### **Step 1: Run the Automated Review Script**6```bash7# Make the script executable8chmod +x review_dependabot_prs.sh9 10# Run the review workflow11./review_dependabot_prs.sh12```13 14This script will:15- โœ… Run local tests first16- โœ… Test Docker builds17- โœ… Open each PR in your browser18- โœ… Guide you through review decisions19- โœ… Log all decisions for tracking20 21## ๐Ÿš€ **Cursor-Specific Review Workflow**22 23### **Method 1: Using Cursor's GitHub Integration**24 25#### **Open All PRs in Cursor:**26```bash27# In Cursor command palette (Cmd+Shift+P):28GitHub: View Pull Requests29```30 31#### **Review Each PR:**321. **Select PR** from the list332. **Review changes** in side-by-side diff343. **Add comments** using Cursor's inline commenting354. **Use AI assistance** for code review365. **Approve or request changes**37 38### **Method 2: Direct PR URLs**39 40#### **EAName Repository PRs:**41```bash42# In Cursor command palette:43GitHub: Open Pull Request from URL44 45# Then paste these URLs one by one:46https://github.com/EAName/algorithmic_trading/pull/647https://github.com/EAName/algorithmic_trading/pull/548https://github.com/EAName/algorithmic_trading/pull/449https://github.com/EAName/algorithmic_trading/pull/350https://github.com/EAName/algorithmic_trading/pull/251https://github.com/EAName/algorithmic_trading/pull/152```53 54#### **ParallelLLC Repository PRs:**55```bash56# Same process for ParallelLLC:57https://github.com/ParallelLLC/algorithmic_trading/pull/658https://github.com/ParallelLLC/algorithmic_trading/pull/559https://github.com/ParallelLLC/algorithmic_trading/pull/460https://github.com/ParallelLLC/algorithmic_trading/pull/361https://github.com/ParallelLLC/algorithmic_trading/pull/262https://github.com/ParallelLLC/algorithmic_trading/pull/163```64 65## ๐Ÿ” **Review Checklist for Each PR**66 67### **Critical PRs (Review First):**68 69#### **1. Python 3.13 Update (PR #6)**70**Priority: HIGH**71```bash72# Check for breaking changes73- [ ] All dependencies compatible with Python 3.1374- [ ] No deprecated features used75- [ ] Performance impact minimal76- [ ] Trading logic unaffected77```78 79#### **2. Docker Action Updates (PRs #2, #4)**80**Priority: MEDIUM**81```bash82# Check CI/CD pipeline83- [ ] Docker builds still work84- [ ] Image size reasonable85- [ ] Security improvements86- [ ] No breaking changes87```88 89#### **3. GitHub Actions Updates (PRs #1, #3, #5)**90**Priority: LOW**91```bash92# Check workflow compatibility93- [ ] Actions still function94- [ ] No deprecated features95- [ ] Performance improvements96- [ ] Security enhancements97```98 99## ๐Ÿค– **Using Cursor's AI for PR Review**100 101### **AI-Assisted Review Commands:**102 103#### **1. Ask AI to Review Changes:**104```bash105# In Cursor chat:106"Review this PR for breaking changes and security issues"107```108 109#### **2. Check for Trading-Specific Issues:**110```bash111# In Cursor chat:112"Check if these dependency updates affect our trading algorithms or risk management"113```114 115#### **3. Validate CI/CD Pipeline:**116```bash117# In Cursor chat:118"Verify that these GitHub Actions updates won't break our CI/CD pipeline"119```120 121### **AI Review Prompts:**122 123#### **For Python 3.13 Update:**124```125"Review this Python 3.13 update for:1261. Breaking changes in our trading dependencies1272. Performance impact on our algorithms1283. Security improvements1294. Compatibility with our Docker setup"130```131 132#### **For GitHub Actions Updates:**133```134"Review these GitHub Actions updates for:1351. Workflow compatibility1362. Security improvements1373. Performance enhancements1384. Any deprecated features"139```140 141## ๐Ÿ“Š **Review Decision Matrix**142 143### **Approve If:**144- โœ… No breaking changes detected145- โœ… Tests pass locally146- โœ… Docker builds successfully147- โœ… Security improvements included148- โœ… Performance maintained or improved149 150### **Request Changes If:**151- โŒ Breaking changes found152- โŒ Tests fail153- โŒ Docker build fails154- โŒ Security vulnerabilities introduced155- โŒ Performance degradation156 157### **Comment Only If:**158- ๐Ÿ’ฌ Minor concerns that don't block approval159- ๐Ÿ’ฌ Suggestions for future improvements160- ๐Ÿ’ฌ Questions about implementation161- ๐Ÿ’ฌ Documentation requests162 163## ๐Ÿ›ก๏ธ **Trading-Specific Review Criteria**164 165### **Risk Management:**166- [ ] No changes to risk calculation logic167- [ ] Position limits still enforced168- [ ] Drawdown protection maintained169- [ ] Compliance requirements met170 171### **Performance:**172- [ ] Algorithm execution time unchanged173- [ ] Memory usage reasonable174- [ ] CPU utilization acceptable175- [ ] API response times maintained176 177### **Security:**178- [ ] No new vulnerabilities introduced179- [ ] API keys still secure180- [ ] Authentication mechanisms intact181- [ ] Data encryption maintained182 183## ๐ŸŽฏ **Efficient Review Strategy**184 185### **Batch Review Approach:**186 187#### **Phase 1: Critical Updates (30 minutes)**1881. **Python 3.13 Update** - Test thoroughly1892. **Docker Updates** - Verify builds1903. **Security Updates** - Validate improvements191 192#### **Phase 2: Standard Updates (15 minutes)**1931. **GitHub Actions** - Quick compatibility check1942. **Minor Dependencies** - Standard review1953. **Documentation Updates** - Verify accuracy196 197#### **Phase 3: Approval (5 minutes)**1981. **Approve safe updates**1992. **Request changes for issues**2003. **Merge approved PRs**201 202## ๐Ÿ“ **Review Template**203 204### **For Each PR, Use This Template:**205 206```markdown207## PR Review: [PR Title]208 209### โœ… What I Reviewed:210- [ ] Code changes211- [ ] Dependency updates212- [ ] Breaking changes213- [ ] Security implications214- [ ] Performance impact215- [ ] Local testing216- [ ] Docker build217 218### ๐Ÿ” Findings:219- **Breaking Changes**: [Yes/No]220- **Security Issues**: [Yes/No]221- **Performance Impact**: [None/Minor/Major]222- **Test Results**: [Pass/Fail]223 224### ๐Ÿ’ฌ Comments:225[Add any specific comments or suggestions]226 227### โœ… Decision:228- [ ] **Approve** - Safe to merge229- [ ] **Request Changes** - Issues found230- [ ] **Comment Only** - Minor concerns231```232 233## ๐Ÿš€ **Quick Commands for Cursor**234 235### **Keyboard Shortcuts:**236```bash237Cmd+Shift+P          # Command palette238Cmd+Shift+G          # Source control239Cmd+Enter            # Submit review240Cmd+Shift+Enter      # Approve PR241Cmd+/                # Toggle comment242```243 244### **Useful Commands:**245```bash246GitHub: View Pull Requests247GitHub: Open Pull Request from URL248GitHub: Review Pull Request249GitHub: Add Comment to Pull Request250```251 252## โœ… **Success Metrics**253 254### **Review Goals:**255- **Time**: Complete all 12 PRs in < 1 hour256- **Quality**: 100% of critical issues caught257- **Safety**: No breaking changes merged258- **Efficiency**: Use AI assistance for 80% of reviews259 260### **Quality Checklist:**261- [ ] All PRs reviewed within 24 hours262- [ ] No critical issues missed263- [ ] All approved PRs pass CI/CD264- [ ] Documentation updated as needed265- [ ] Team notified of any issues266 267---268 269**Ready to start? Run `./review_dependabot_prs.sh` to begin the automated review workflow!**