CodingFox is an intelligent AI-powered code review assistant that revolutionizes your pull request workflow. Using advanced language models (GPT-3.5 Turbo and GPT-4), CodingFox provides instant, contextual code reviews that catch bugs, improve code quality, and accelerate your development cycle.
- ⚡ Lightning-Fast Reviews: Get comprehensive code reviews in seconds, not hours
- 🎯 Context-Aware Analysis: Understands your codebase and provides relevant suggestions
- 🛡️ Bug Prevention: Catches potential issues before they reach production
- 💡 Smart Suggestions: Offers actionable improvements, not just criticism
- 🔄 Continuous Learning: Improves with every review based on your feedback
- 💰 Cost-Effective: Reduce review time by 60% while improving code quality
- Automated PR Summaries: Generate comprehensive summaries and release notes
- Line-by-Line Review: Detailed suggestions for every code change
- Pattern Recognition: Identifies anti-patterns and suggests best practices
- Security Analysis: Flags potential security vulnerabilities
- Incremental Reviews: Reviews each commit individually for better context
- Selective Analysis: Skips trivial changes to focus on what matters
- Multi-Model Support: Uses lightweight models for summaries, powerful ones for reviews
- Custom Prompts: Tailor review focus to your team's needs
- Chat with CodingFox: Ask questions about specific code sections
- Test Generation: Request test cases for your changes
- Code Simplification: Get suggestions for reducing complexity
- Documentation Helper: Generate or improve code documentation
Get CodingFox running in your repository in under 5 minutes!
Before you begin, ensure you have:
- A GitHub repository where you want to add CodingFox
- Admin access to the repository (to add secrets)
- An OpenAI account (free tier works to start)
-
Sign up for OpenAI (if you haven't already):
- Go to OpenAI Platform
- Create your account
-
Generate an API Key:
- Navigate to API Keys page
- Click "Create new secret key"
- Give it a name (e.g., "CodingFox")
- Copy the key immediately (you won't see it again!)
-
Add Credits (for new accounts):
- Go to Billing
- Add at least $5 to get started (this will last for hundreds of PR reviews)
-
Navigate to your GitHub repository
-
Go to Settings:
- Click on the Settings tab in your repository
- Scroll down to Security section in the left sidebar
- Click on Secrets and variables → Actions
-
Add New Secret:
- Click "New repository secret" button
- Name: OPENAI_API_KEY
- Value: Paste your OpenAI API key
- Click "Add secret"
-
Create the workflow directory in your repository:
mkdir -p .github/workflows -
Create the workflow file:
- Create a new file: .github/workflows/codingfox-review.yml
- Copy and paste this configuration:
- Commit and push the workflow file:
git add .github/workflows/codingfox-review.yml git commit -m "Add CodingFox AI code review" git push
-
Create a test pull request:
- Make any small change in your repository
- Create a new branch: git checkout -b test-codingfox
- Make a change and commit
- Push and create a pull request
-
Watch CodingFox in action:
- Within 30-60 seconds, CodingFox will comment on your PR
- You'll see a summary, code review comments, and release notes
-
Interact with CodingFox:
- Try commenting @codingfox help me write tests for this function
- CodingFox will respond with helpful suggestions
For more thorough and accurate reviews, upgrade to GPT-4:
CodingFox not commenting | Check Actions tab for errors, verify OPENAI_API_KEY is set |
"Rate limit exceeded" | Add credits to OpenAI account or reduce openai_concurrency_limit |
Reviews too verbose | Set review_simple_changes: false |
Missing some files | Check path_filters and max_files settings |
Timeout errors | Increase openai_timeout_ms (default: 360000) |
- Start with GPT-3.5: It's very cost-effective for initial testing
- Use path filters: Focus on important directories like src/
- Customize prompts: Tailor reviews to your team's standards
- Monitor costs: Check OpenAI usage dashboard regularly
- Iterate on feedback: Adjust settings based on team preferences
Once installed, CodingFox will:
- ✅ Automatically review every new pull request
- ✅ Generate PR summaries and release notes
- ✅ Provide line-by-line code suggestions
- ✅ Respond to your questions and requests
- ✅ Learn from your codebase patterns
Simply create a pull request and CodingFox will automatically:
- Generate a comprehensive PR summary
- Review code changes line-by-line
- Suggest improvements and catch issues
- Create release notes
Tag @codingfox in any PR comment:
Add to PR description to skip review:
Customize CodingFox's personality and focus:
GPT-3.5 Turbo | Summaries | ~$0.002 per PR |
GPT-4 | Full Review | ~$0.10-0.50 per PR |
Typical Usage: A 20-developer team reviewing 50 PRs/day costs approximately $20-30/day with GPT-4.
- Data Processing: Code is sent to OpenAI's API for analysis
- Data Retention: OpenAI API has strict data usage policies
- Compliance: Review with your security team for sensitive repositories
- Self-Hosting: Contact us for on-premise deployment options
- Node.js 17+
- npm or yarn
We welcome contributions! Please see our Contributing Guide for details.
Review Speed | ⚡ Instant | 🐌 Hours/Days | ⚡ Instant |
Context Understanding | ✅ Full | ✅ Full | ⚠️ Limited |
Consistency | ✅ 100% | ❌ Variable | ✅ 100% |
Availability | ✅ 24/7 | ❌ Business Hours | ✅ 24/7 |
Learning Curve | ✅ None | ❌ Team Dependent | ⚠️ Moderate |
Customization | ✅ Extensive | ✅ Full | ⚠️ Limited |
Cost | 💰 Low | 💰💰💰 High | 💰💰 Medium |
"CodingFox reduced our PR review time by 65% while catching 40% more bugs before production." - Tech Lead, Fortune 500
"The contextual suggestions are incredible. It's like having a senior developer review every line of code." - Startup CTO
"We save $50k+ annually on review time alone. CodingFox pays for itself in days." - Engineering Manager
MIT License - see LICENSE file for details.
CodingFox - Elevating Code Quality, One Review at a Time