aidevops 2.52.1

package/.agent/tools/code-review/setup.md

@@ -0,0 +1,250 @@
+---
+description: Setup guide for code quality services
+mode: subagent
+tools:
+  read: true
+  write: true
+  edit: true
+  bash: true
+  glob: true
+  grep: true
+  webfetch: true
+  task: true
+---
+
+# Code Quality Services Setup Guide
+
+<!-- AI-CONTEXT-START -->
+
+## Quick Reference
+
+- 4 platforms: CodeRabbit (AI reviews), CodeFactor (grading), Codacy (security), SonarCloud (enterprise)
+- Setup time: ~5 min each, all use GitHub OAuth
+- CodeRabbit: coderabbit.ai -> Add repo -> Enable PR reviews
+- CodeFactor: codefactor.io -> Add repo -> Enable GitHub Checks
+- Codacy: app.codacy.com -> Import repo -> Uses .codacy.yml
+- SonarCloud: sonarcloud.io -> Create org -> Import project -> Get token -> Add `SONAR_TOKEN` secret
+- Config files: .codacy.yml, sonar-project.properties (already in repo)
+- Expected grades: CodeFactor A+, Codacy A, SonarCloud passed gate
+- Troubleshooting: Check secrets, webhook configs, repo permissions
+<!-- AI-CONTEXT-END -->
+
+This guide walks you through setting up all 4 integrated code quality and security analysis platforms for your AI DevOps Framework.
+
+## Overview
+
+The framework integrates with 4 major code analysis platforms:
+
+- **🤖 CodeRabbit** - AI-powered code reviews and security analysis
+- **📊 CodeFactor** - Automated code quality grading and metrics
+- **🛡️ Codacy** - Code quality, security, and coverage analysis
+- **⚡ SonarCloud** - Professional security and maintainability analysis
+
+## 🚀 **Quick Setup (5 Minutes Each)**
+
+### **1. 🤖 CodeRabbit Setup**
+
+#### **Steps:**
+
+1. **Visit**: https://coderabbit.ai/
+2. **Sign up** with your GitHub account
+3. **Authorize** CodeRabbit to access your repositories
+4. **Add Repository**: Select `marcusquinn/aidevops`
+5. **Configure**: Enable automatic PR reviews
+
+#### **Features You Get:**
+
+- AI-powered code reviews on every pull request
+- Security vulnerability detection
+- Context-aware suggestions
+- Integration with GitHub checks
+
+#### **Badge for README:**
+
+```markdown
+[![CodeRabbit](https://img.shields.io/badge/CodeRabbit-AI%20Reviews-blue)](https://coderabbit.ai)
+```
+
+### **2. 📊 CodeFactor Setup**
+
+#### **Steps:**
+
+1. **Visit**: https://www.codefactor.io/
+2. **Sign up** with your GitHub account
+3. **Add Repository**: Click "Add new repository"
+4. **Select**: `marcusquinn/aidevops`
+5. **Enable**: GitHub Checks for PR integration
+
+#### **Features You Get:**
+
+- Automatic code quality grading (A-F scale)
+- Technical debt tracking
+- Issue categorization and prioritization
+- Quality trends over time
+
+#### **Badge for README:**
+
+```markdown
+[![CodeFactor](https://www.codefactor.io/repository/github/marcusquinn/aidevops/badge)](https://www.codefactor.io/repository/github/marcusquinn/aidevops)
+```
+
+### **3. 🛡️ Codacy Setup**
+
+#### **Steps:**
+
+1. **Visit**: https://app.codacy.com/
+2. **Sign up** with your GitHub account
+3. **Add Repository**: Import from GitHub
+4. **Select**: `marcusquinn/aidevops`
+5. **Configure**: Uses the `.codacy.yml` configuration we provided
+
+#### **Features You Get:**
+
+- Comprehensive security analysis
+- Code quality metrics
+- Custom quality rules
+- Team collaboration features
+
+#### **Badge for README:**
+
+```markdown
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/[PROJECT_ID])](https://app.codacy.com/gh/marcusquinn/aidevops/dashboard)
+```
+
+### **4. ⚡ SonarCloud Setup**
+
+#### **Steps:**
+
+1. **Visit**: https://sonarcloud.io/
+2. **Sign up** with your GitHub account
+3. **Create Organization**: Link to your GitHub account
+4. **Add Project**: Import `marcusquinn/aidevops`
+5. **Get Token**: My Account → Security → Generate Token
+6. **Add Secret**: In GitHub repo settings → Secrets → `SONAR_TOKEN`
+
+#### **Features You Get:**
+
+- Professional security analysis
+- Code smell detection
+- Quality gate enforcement
+- Comprehensive reporting
+
+#### **Badge for README:**
+
+```markdown
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=marcusquinn_aidevops&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=marcusquinn_aidevops)
+```
+
+## 🔧 **GitHub Integration Setup**
+
+### **SonarCloud GitHub Actions Integration:**
+
+1. **Get SonarCloud Token:**
+   - Go to SonarCloud → My Account → Security
+   - Generate new token with name: `GitHub Actions`
+   - Copy the token
+
+2. **Add GitHub Secret:**
+   - Go to your GitHub repository
+   - Settings → Secrets and variables → Actions
+   - Click "New repository secret"
+   - Name: `SONAR_TOKEN`
+   - Value: [paste your token]
+
+3. **Verify Integration:**
+   - Push a commit to trigger GitHub Actions
+   - Check Actions tab for successful SonarCloud analysis
+
+## 📊 **What Each Service Analyzes**
+
+### **🤖 CodeRabbit Analysis:**
+
+- **AI Code Reviews**: Context-aware suggestions
+- **Security Issues**: Vulnerability detection
+- **Best Practices**: Code pattern recommendations
+- **Performance**: Optimization suggestions
+
+### **📊 CodeFactor Analysis:**
+
+- **Code Quality**: Overall quality grading
+- **Complexity**: Cyclomatic complexity analysis
+- **Maintainability**: Technical debt assessment
+- **Trends**: Quality evolution over time
+
+### **🛡️ Codacy Analysis:**
+
+- **Security**: Security vulnerability scanning
+- **Quality**: Code quality metrics
+- **Coverage**: Test coverage tracking (when tests added)
+- **Standards**: Coding standard compliance
+
+### **⚡ SonarCloud Analysis:**
+
+- **Security Hotspots**: Detailed security analysis
+- **Code Smells**: Maintainability issues
+- **Bugs**: Potential bug detection
+- **Duplications**: Code duplication analysis
+
+## 🎯 **Expected Results**
+
+### **Immediate Analysis:**
+
+- **GitHub Actions**: Automated analysis on every push
+- **Pull Request Reviews**: Automated feedback on PRs
+- **Quality Metrics**: Comprehensive quality scoring
+- **Security Reports**: Detailed security analysis
+
+### **Quality Scores Expected:**
+
+- **CodeFactor**: A+ grade (excellent code organization)
+- **Codacy**: A grade (high-quality shell scripts and docs)
+- **SonarCloud**: Passed quality gate (zero security issues)
+- **CodeRabbit**: Positive AI feedback (well-structured framework)
+
+## 🏆 **Professional Benefits**
+
+### **Credibility:**
+
+- **Quality Badges**: Professional quality validation
+- **Automated Analysis**: Continuous quality monitoring
+- **Security Validation**: Zero known vulnerabilities
+- **Best Practices**: Industry-standard compliance
+
+### **Community Trust:**
+
+- **Transparent Quality**: Public quality metrics
+- **Professional Standards**: Enterprise-grade analysis
+- **Continuous Improvement**: Automated feedback loops
+- **Contributor Confidence**: Clear quality guidelines
+
+## 🔍 **Troubleshooting**
+
+### **Common Issues:**
+
+#### **SonarCloud Not Running:**
+
+- Check `SONAR_TOKEN` secret is set correctly
+- Verify organization setup in SonarCloud
+- Check `sonar-project.properties` configuration
+
+#### **CodeRabbit Not Reviewing:**
+
+- Ensure repository is added to CodeRabbit
+- Check GitHub app permissions
+- Verify PR creation triggers reviews
+
+#### **CodeFactor Not Updating:**
+
+- Check repository connection in CodeFactor
+- Verify GitHub webhook configuration
+- Ensure repository is public or properly authorized
+
+#### **Codacy Analysis Issues:**
+
+- Check `.codacy.yml` configuration
+- Verify repository import was successful
+- Check supported file types are being analyzed
+
+---
+
+**Once all 4 services are set up, your repository will have comprehensive, automated code quality and security analysis - establishing it as a professional, high-quality open source project!** 🌟🔍✨