GitHub Copilot Code Review Assistant (GCCR)

A Visual Studio Code extension that leverages GitHub Copilot to assist developers with code reviews by analyzing changes between Git branches.

Features

• Branch Comparison: Review code changes between any two Git branches or tags
• Product Owner Requirements Check: Verify if all product owner requirements are implemented correctly
• Comprehensive Code Review: Analyze code changes for:
  • Regressions in functionality
  • Unnecessary code removal
  • Inconsistencies and logical errors
  • Missing validation checks
  • Code quality and best practices
  • Documentation needs
  • Unclear naming
  • Exception handling
  • Security vulnerabilities
  • Points needing clarification
  • Performance/maintainability improvements

Usage

1. Open the VS Code chat panel (Ctrl+Shift+P > "Open Chat")
2. Type @gccr to start the review process
3. Select the target and base branches/tags to compare
4. Enter any product owner requirements or feature specifications to verify
5. Review the results, which are organized into two sections:
   • Product Owner Requirements Review
   • Code Review Details

Configuration

The extension provides the following settings:

• gccr.minSeverity (default: 2): Minimum severity level for issues to be reported (1-5)
  • 1: Show all issues including minor suggestions
  • 5: Show only critical issues
• gccr.enableDebugOutput (default: false): Include additional debug information in the output

Requirements

• Visual Studio Code 1.94.0 or higher
• GitHub Copilot Chat extension
• Git repository

Limitations

• GCCR may lack some information on how your changes work together. Most comments will point out local bugs or typos rather than architecture-level comments looking at how multiple files work together.
• For larger change sets (e.g. >100 files) you may encounter rate-limiting errors from Copilot. Please wait for the indicated time before retrying.

Data Usage

Source code checked into Git and selected for review, along with commit messages and product owner requirements, will be sent to GitHub Copilot. Avoid using it on repositories where you would not use Copilot.

Contributing

This extension is open source. Feel free to contribute by:

• Reporting issues
• Suggesting improvements
• Submitting pull requests

License

This project is licensed under the MIT License - see the LICENSE file for details.

Credits

This project was clonded lgtm, a similar VS Code extension for code reviews.