From 21c888915c40b3530d95f0f294791746ef44a4f4 Mon Sep 17 00:00:00 2001 From: LearningCircuit <185559241+LearningCircuit@users.noreply.github.com> Date: Mon, 10 Nov 2025 00:05:41 +0100 Subject: [PATCH] docs: update example to showcase iterative review process Replace the example PR link with a better demonstration (PR #1034) that shows: - Critical bug detection (MODEL variable syntax error) - Architecture improvements (CPU-base pattern, duplication elimination) - High-priority fixes (breaking changes, platform-specific gaps) - Final approval after addressing all issues This example better demonstrates the AI reviewer's value in catching production bugs and improving code quality. --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 84b4826..fe6609c 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,14 @@ - Creates highly-customizable AI Reviews as PR comments. - Installation: Just 2 files copied to your repo and an OpenRouter API Key in your secrets. - Costs: $0.01 - $0.05 per review (even for large PRs with full context) -- **Example output**: https://github.com/LearningCircuit/local-deep-research/pull/959#issuecomment-3445396169 +- **Example output**: https://github.com/LearningCircuit/local-deep-research/pull/1034#issuecomment-3508864021 + - **Why this example is great**: This PR shows the AI reviewer's iterative improvement process catching critical bugs and quality issues: + - **Critical Bug Caught**: MODEL variable syntax error that would have silently failed in production + - **Architecture Improvements**: Pushed from GPU-base → CPU-base pattern and eliminated 130 lines of duplication + - **High-Priority Fixes**: Breaking change warnings, curl overwrite warnings, platform-specific gaps, nvidia-smi verification + - **Quality Enhancements**: Consistent formatting, better documentation, removed outdated comments + - **Final Approval**: After addressing all issues, the AI gave full approval - showing it doesn't infinitely continue + - **Real Value**: Saved shipping a critical bug and forced better architecture decisions This guide explains how to set up the automated AI PR review system using OpenRouter to analyze pull requests with your choice of AI model.