Skip to content
PR Readiness Coach Walkthrough

Overview

This site is the documentation companion for jajera/pr-readiness-coach. Product code (CLI, Lambda, CDK, web UI, hooks) lives upstream; pages here adapt the operator walkthrough, Builder Center article, and capture notes into a progressive guide.

What this isWhat this is not
Static walkthrough and architecture referenceThe application or CDK source of truth
Operational guidance for every product surfaceA live AWS lab
Companion docs for the product repoA substitute for reading upstream when debugging code

Vision

Section titled “Vision”

Opening a pull request should feel like a confident hand-off. PR Readiness Coach
AI coach that answers “is this branch ready for a PR?” via heuristics and optional Bedrock agents. gathers branch context, runs fast heuristics
Fast local pre-screen for secrets, TODOs, debug logs, and custom regex — no Bedrock cost; used by `--local`, save hooks, and CI fallback., then (when available) walks a short multi-agent Bedrock
Amazon Bedrock Converse API used for Diff Analyst, Risk Reviewer, and Ship Coach — defaults target ap-southeast-2 (Nova Lite + Claude Haiku 4.5 AU profile). pipeline: Diff Analyst → Risk Reviewer → Ship Coach. You get a structured verdict
Structured report outcome: READY, READY WITH WARNINGS, or NOT READY — with blockers, warnings, and checklist. with blockers, warnings, checklist, draft PR title/body, and top actions.

The same core powers four entry points:

  1. Local CLI (pr-ready)
  2. AWS API (API Gateway + Lambda) used by GitHub Actions
  3. Optional Kiro IDE hooks (warn-only)
  4. Owner-only Amplify SPA (Cognito → run history + Try it)

Who this is for

Section titled “Who this is for”
  • Developers checking readiness before opening a PR
  • Teams wanting warn-only CI coaching comments
  • Kiro users wanting local save / on-demand feedback
  • Operators running fixture demos or deploying the CDK stack

Success criteria

Section titled “Success criteria”
  • Run fixtures/demo.sh and see expected READY / NOT READY verdicts without AWS
  • Optionally deploy the stack in ap-southeast-2, call /analyze, and open the Cognito-gated UI
  • Understand that CI and hooks are warn-only
    CI and Kiro hooks always exit 0 — they coach with comments/reports but never hard-block merges in v1.     — they coach, they do not hard-gate merges in v1

Non-goals

Section titled “Non-goals”
  • Hard merge gates, WAF, or IAM SigV4 for the API
  • Replacing code review or security scanning products
  • Duplicating Terraform/CDK modules inside this docs repo