Extract shared readiness-checks spec in pr-flow v1.2.1#7
Merged
Conversation
Owner
Author
|
@claude review |
Pull the duplicated documentation-readiness logic out of /open (steps 3c-3f) and /merge (step 8) into a single canonical spec, following the REVIEW-OUTPUT-FORMAT.md pattern. - Add plugins/pr-flow/docs/READINESS-CHECKS.md: detection signals, status semantics, auto-fixable vs. manual classification - /open 3c-3f now reference the spec, keep only open-specific auto-resolution behavior (-563 words) - /merge step 8 references the spec, keeps only read-only + f/m/a handling (-111 words) - README: note the shared spec, mirroring REVIEW-OUTPUT-FORMAT - Bump pr-flow 1.2.0 -> 1.2.1 (plugin.json + marketplace.json) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
0f1a13f to
aa709ac
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/open(steps 3c–3f) and/merge(step 8) into one canonical spec, following the provenREVIEW-OUTPUT-FORMAT.mdpattern./mergestep 8 previously had to "mirror/openchecks 3c-3f" by hand.Behavior change (intentional harmonization)
Before this PR,
/openand/mergedisagreed on the README-freshness check:/opentreated touching any*.mdfile as satisfying it, while/mergecounted onlyREADME.md. The shared spec adopts/merge's stricter rule, so/opennow also warns when user-facing code changed but only a non-README markdown file (e.g.CONTRIBUTING.md) was touched. This is the point of the extraction — one canonical definition — but it does slightly tighten/open's heuristic. The check is advisory only.Changes
plugins/pr-flow/docs/READINESS-CHECKS.md— canonical definitions for the four checks (README freshness, version bump, changelog, knowledge/conventions): detection signals, ✅//open3c–3f now reference the spec; keep only open-specific behavior (auto-resolve fixes in place during the check phase). −563 words./mergestep 8 now references the spec; keep only merge-specific behavior (read-only inspection,DOC_WARNINGScollection for the step-13 f/m/a decision). −111 words.README.md: note the shared spec, mirroring howREVIEW-OUTPUT-FORMAT.mdis surfaced.plugin.json+marketplace.json).Readiness
TASK.md(work-system file, intentionally excluded)Test plan
/openon a branch and confirm 3c–3f resolve correctly from the spec/mergeand confirm step 8 stays read-only and surfacesDOC_WARNINGSin the step-13 plan${CLAUDE_PLUGIN_ROOT}/docs/READINESS-CHECKS.mdresolves at runtime (same mechanism asREVIEW-OUTPUT-FORMAT.md)🤖 Generated with Claude Code