Skip to content

Add automated design review for system design PRs#22

Merged
SweetCodey merged 1 commit intomainfrom
add-design-review-automation
Mar 10, 2026
Merged

Add automated design review for system design PRs#22
SweetCodey merged 1 commit intomainfrom
add-design-review-automation

Conversation

@SweetCodey
Copy link
Owner

Summary

  • Adds a GitHub Action that auto-reviews system design documents on PR open/update
  • Only triggers for PRs modifying .md files in numbered design folders (e.g., 15. Design Google Maps/)
  • Uses Claude API with the SweetCodey review guidelines to post line-specific PR comments
  • Dismisses previous bot reviews on re-runs to avoid duplicate comments

Setup Required

Add ANTHROPIC_API_KEY as a repository secret in Settings → Secrets → Actions.

Files

  • .github/workflows/design-review.yml — GitHub Action workflow
  • .github/scripts/review_design.py — Review script (calls Claude API, posts comments)
  • .github/review-skill/review-system-design.md — Review guidelines
  • .github/review-skill/writing-style-guide.md — SweetCodey writing style reference

🤖 Generated with Claude Code

Adds a GitHub Action that automatically reviews system design documents
when a PR is opened or updated. Only triggers for PRs that modify .md
files in numbered design folders (e.g., "15. Design Google Maps/").

Uses Claude API with the SweetCodey review guidelines to post
line-specific comments on the PR.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@SweetCodey SweetCodey merged commit 19975d2 into main Mar 10, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants