Pull request review prep
Summarize test evidence, rate review risk, flag breaking changes, check migration notes and draft the release note before a person reviews.
Scenario paths
Pick a predefined path to highlight it through the chain. No model is called; outcomes are illustrative.
- Steps
- Endpoints
- Draft release note, request review
- No release note, request review
- Expert reviewer
- Maintainer review
What each endpoint means
Draft release note, request review · Automated
Adds a draft note in the right section and requests a reviewer. A person reviews and merges.
No release note, request review · Automated
Marked internal and sent for review. A person reviews and merges.
Ask the author · Automated
Asks for test information or migration notes before review.
Expert reviewer · Human review
A code owner for the sensitive area is requested.
Maintainer review · Human review
A maintainer decides how to handle an unclear case.
Steps
Summarize testing evidence for the reviewer.
- Tests addedExisting coverage claimedManual testing onlyReviewer checksPull request change risk
- Ask authorAsk the author
Question, inputs and notes
Asks:What evidence of testing does this pull request give?
Receives
- Inputdescription
- Inputchanged_files
Branches
- Ask author: The author is asked before a reviewer is assigned.
Choose how much review attention it needs.
- Light reviewRelease note category
- Standard reviewCareful reviewBreaking change signal
- Expert reviewerMaintainer decidesExpert reviewer
Question, inputs and notes
Asks:How much review attention does this change need?
Receives
- Inputdescription and changed_files
- Inputsensitive_paths
- From step 1Test evidence
Catch changes to public behaviour.
- Likely breakingMigration guidance check
- Not breakingRelease note category
- UnclearMaintainer review
Question, inputs and notes
Asks:Does this change alter public behaviour in a way that could break existing users?
Receives
- Inputdescription
- Inputpublic_surface_changes
- Migration guidance checkChoice
Make sure users get migration steps.
- Clear stepsRelease note category
- Ask for more detailAsk for migration notesAsk the author
- Maintainer checksMaintainer review
Question, inputs and notes
Asks:How clearly does this pull request tell users how to migrate?
Receives
- Inputdocs_changes
- From step 3What breaks
- Release note categoryChoice
Place the change in the draft release notes.
- FeaturesFixesBreaking changesDeprecationsDraft release note, request review
- Leave outNo release note, request review
- Release managerMaintainer review
Question, inputs and notes
Asks:Which release notes section does this change belong in?
Receives
- Inputdescription and labels
About this chain
Goal and input
Every pull request reaches a human reviewer prepared: with a draft release note, a question back to the author, or an expert reviewer assigned.
PR description, changed files with line counts, public surface changes and sensitive paths.
- description
- PR title and description.
- changed_files
- Paths, line counts and test file flags, computed in code.
- public_surface_changes
- API, flag and config changes, from an API diff tool.
- docs_changes
- Changelog and docs changes.
- sensitive_paths
- Paths code owners mark as sensitive.
How it runs
- Every path ends with a person reviewing. The chain prepares the review; it never approves, merges or skips review.
- Line counts, test file detection and API diffs come from tools. The classifiers read descriptions and judge impact.
Sources (3)
Primary documentation this chain builds on.
- SourcedTypeSafe docs · DocumentationSystem One
- SourcedTypeSafe docs · PatternSpeculative fan-out
- SourcedTypeSafe docs · PatternRouting by probability