docs(#6838): add consumer-completeness touchpoints to runtime checklist - #6839
docs(#6838): add consumer-completeness touchpoints to runtime checklist#6839fullsend-ai-coder[bot] wants to merge 3 commits into
Conversation
The existing "Adding a runtime" checklist had 5 high-level items but did not name the specific consumer files that need updating when a runtime is added or renamed. PR #6789 (dummy-playback runtime) missed 9+ consumer files — registry tests, config validation, CLI prompt filtering, CLI help text, and documentation — driving 3–5 extra review-fix iterations. Add a "Consumer-completeness touchpoints" sub-section with a file-level markdown checklist covering registration, config validation, tests, CLI, and documentation files. Structured as checkboxes so agents and humans can use it as a mechanical walkthrough. Closes #6838
Site previewPreview: https://1e6f552c-site.fullsend-ai.workers.dev Commit: |
|
🤖 Finished Review · ✅ Success · Started 4:03 AM UTC · Completed 4:17 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $4.92 |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
Risk Assessment: moderate (2/5) DetailsSmall docs-only addition to a single checklist file with well-matched issue scope and bot authorship; elevated to moderate due to high recent churn (12 commits in 30d) and some fix commits on this file. Tier 1/2/3 signals unchanged from prior assessment; preserving anchored score. Previous runRisk Assessment: moderate (2/5) DetailsSmall docs-only addition to a single checklist file with well-matched issue scope and bot authorship; elevated to moderate due to high recent churn (12 commits in 30d) and some fix commits on this file. Tier 1/2/3 signals unchanged from prior assessment; preserving anchored score. Previous run (2)Risk Assessment: moderate (2/5) DetailsSmall docs-only addition to a single checklist file with well-matched issue scope and bot authorship; elevated to moderate due to high recent churn (12 commits in 30d) and some fix commits on this file. |
|
Looks good to me Previous runReviewFindingsMedium
Low
Next steps:
Previous run (2)ReviewFindingsLow
Labels: PR modifies contributing documentation for runtime implementation Next steps:
|
|
🤖 Finished Fix · ✅ Success · Started 4:19 AM UTC · Completed 4:24 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $1.22 |
- Replace "sub-test" with "assertion block" in TestResolve checklist item to match the flat test structure (no t.Run() sub-tests) - Replace vague admin.go checklist item with specific reference to newInstallCmd() and its --runtime flag description Addresses #6839
🔧 Fix agent — iteration 1 (bot-triggered)Both review findings addressed: corrected 'sub-test' terminology to 'assertion block' to match TestResolve's flat structure, and made the admin.go checklist item specific by naming newInstallCmd() explicitly. Fixed (2):
Tests: passedNext steps:
|
|
🤖 Finished Review · ✅ Success · Started 4:26 AM UTC · Completed 4:41 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $4.77 |
|
🤖 Finished Fix · ✅ Success · Started 4:43 AM UTC · Completed 4:48 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $1.51 |
…dancy Add missing `internal/cli/github.go` checklist item under the CLI section — its `--runtime` flag in `newGitHubSetupCmd()` has a hardcoded valid-values string that needs updating when a runtime is added. Annotate the `registry.go` item with a parenthetical noting it mirrors step 1 so the walkthrough is intentionally self-contained. Addresses #6839
🔧 Fix agent — iteration 2 (bot-triggered)Added missing github.go checklist item to the CLI section and clarified the intentional registry.go redundancy with an inline note. Both findings verified against the actual codebase before fixing. Fixed (2):
Tests: passedNext steps:
|
|
🤖 Finished Review · ✅ Success · Started 4:50 AM UTC · Completed 5:06 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $4.01 |
Superseded by updated review
Summary
Expands the "Adding a runtime: checklist" section in
docs/contributing/runtime-implementation.mdwith a file-level consumer-completeness sub-checklist. The existing checklist had 5 high-level items but did not name the specific files that need updating when a runtime is added or renamed, causing PR #6789 to miss 9+ consumer files and require 3–5 extra review-fix iterations.Changes
registry.go(Resolve()) andconfig.go(ValidRuntimes())registry_test.goandconfig_test.goassertionsruntime_prompt.go(prompt filtering),run.goandadmin.go(flag descriptions)runtimes.md,architecture.md,docs/cli/run.md,docs/cli/github.md, andlayered-config-reference.mdTesting
lycheemarkdown link checker passes (28 total, 0 errors)lint-docs-linkspassesscan-secretspassesgitlintpassesCloses #6838
Post-script verification
agent/6838-expand-runtime-checklist)87cb9cb35cbf656502507e105899c4eb3179559e..HEAD)