Skip to content

docs(#6838): add consumer-completeness touchpoints to runtime checklist - #6839

Open
fullsend-ai-coder[bot] wants to merge 3 commits into
mainfrom
agent/6838-expand-runtime-checklist
Open

docs(#6838): add consumer-completeness touchpoints to runtime checklist#6839
fullsend-ai-coder[bot] wants to merge 3 commits into
mainfrom
agent/6838-expand-runtime-checklist

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

Summary

Expands the "Adding a runtime: checklist" section in docs/contributing/runtime-implementation.md with 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

  • Added a "Consumer-completeness touchpoints" sub-section with markdown checkboxes covering:
    • Registration and config: registry.go (Resolve()) and config.go (ValidRuntimes())
    • Tests: registry_test.go and config_test.go assertions
    • CLI: runtime_prompt.go (prompt filtering), run.go and admin.go (flag descriptions)
    • Documentation: runtimes.md, architecture.md, docs/cli/run.md, docs/cli/github.md, and layered-config-reference.md

Testing

  • All file paths in the checklist verified to exist in the current codebase
  • lychee markdown link checker passes (28 total, 0 errors)
  • lint-docs-links passes
  • No trailing whitespace, correct line endings
  • scan-secrets passes
  • gitlint passes

Closes #6838

Post-script verification

  • Branch is not main/master (agent/6838-expand-runtime-checklist)
  • Secret scan passed (gitleaks — 87cb9cb35cbf656502507e105899c4eb3179559e..HEAD)
  • PR body secret scan passed (gitleaks — no-git)

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
@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown

Site preview

Preview: https://1e6f552c-site.fullsend-ai.workers.dev

Commit: aa24dc1054f295e7794d1c203d32d39a7049e557

@fullsend-ai-review

fullsend-ai-review Bot commented Sep 1, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 4:03 AM UTC · Completed 4:17 AM UTC

Commit: cb5c72c · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $4.92

@codecov

codecov Bot commented Sep 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@fullsend-ai-review fullsend-ai-review Bot added the risk/moderate PR risk: moderate label Sep 1, 2026
@fullsend-ai-review

fullsend-ai-review Bot commented Sep 1, 2026

Copy link
Copy Markdown

Risk Assessment: moderate (2/5)

Details

Small 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

Risk Assessment: moderate (2/5)

Details

Small 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)

Details

Small 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.

@fullsend-ai-review

fullsend-ai-review Bot commented Sep 1, 2026

Copy link
Copy Markdown

Looks good to me

Previous run

Review

Findings

Medium

  • [consumer completeness] docs/contributing/runtime-implementation.md:64 — The CLI touchpoints section lists internal/cli/run.go and internal/cli/admin.go but omits internal/cli/github.go, which also defines a --runtime flag with a hardcoded valid-values string in newGitHubSetupCmd(). A developer following this checklist would update admin.go and run.go but miss github.go — exactly the failure mode the checklist exists to prevent. The github.go flag description is already stale today (it omits dummy-playback).
    Remediation: Add a checklist item under the CLI: section: - [ ] internal/cli/github.go — update the --runtime flag description in newGitHubSetupCmd() to include the new runtime name.

Low

  • [scope-completeness] docs/contributing/runtime-implementation.md — The checklist's first item ("add a case to Resolve() in registry.go") duplicates existing numbered step 1 ("Register the backend in runtime.Resolve()"). This is mild redundancy rather than a gap, and is arguably intentional for a self-contained mechanical walkthrough.
    Remediation: Consider adding a note like "(mirrors step 1 above — listed here so the walkthrough is self-contained)" to the registry.go item, or remove it and reference step 1.

Next steps:

  • /fs-fix — agent addresses review findings automatically
  • /fs-fix <your instruction> — agent fixes with your specific guidance
  • Push commits directly — review re-runs automatically on push
  • /fs-fix-stop — disable automatic fix runs for this PR
Previous run (2)

Review

Findings

Low

  • [technical accuracy] docs/contributing/runtime-implementation.md:53 — The checklist instructs adding a Resolve("<name>") "sub-test" to TestResolve, but TestResolve in internal/runtime/registry_test.go is a flat function — it does not use t.Run() sub-tests. Each runtime is tested with a direct Resolve() call and assertions. The term "sub-test" could mislead a contributor into structuring the addition as a t.Run() block inconsistent with the existing test style.
    Remediation: Replace "sub-test" with "test case" or "assertion block" to match the actual structure.

  • [cross-reference consistency] docs/contributing/runtime-implementation.md:66 — The checklist item for internal/cli/admin.go says "check for any --runtime flag descriptions or hardcoded runtime lists and update them." This is vague compared to the precise function/case references used in other checklist items. The --runtime flag on newInstallCmd() at line 630 contains a hardcoded description string listing valid runtime names that needs updating.
    Remediation: Name the specific construct, e.g., "update the --runtime flag description in newInstallCmd() to include the new runtime name."


Labels: PR modifies contributing documentation for runtime implementation


Next steps:

  • /fs-fix — agent addresses review findings automatically
  • /fs-fix <your instruction> — agent fixes with your specific guidance
  • Push commits directly — review re-runs automatically on push
  • /fs-fix-stop — disable automatic fix runs for this PR

fullsend-ai-review[bot]

This comment was marked as outdated.

@fullsend-ai-review fullsend-ai-review Bot added the component/docs User-facing documentation label Sep 1, 2026
@fullsend-ai-coder

fullsend-ai-coder Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

🤖 Finished Fix · ✅ Success · Started 4:19 AM UTC · Completed 4:24 AM UTC

Commit: cb5c72c · View workflow run →

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
@fullsend-ai-coder

Copy link
Copy Markdown
Contributor Author

🔧 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):

  1. sub-test terminology inaccurate for TestResolve (docs/contributing/runtime-implementation.md): Replaced "sub-test" with "assertion block" to match the flat test structure in registry_test.go (no t.Run() sub-tests)
  2. admin.go checklist item too vague (docs/contributing/runtime-implementation.md): Replaced vague "check for any --runtime flag descriptions" with specific reference to newInstallCmd() and its --runtime flag description, matching the precision of other checklist items

Tests: passed

Next steps:

  • /fs-review — request a re-review of the changes
  • /fs-fix <your instruction> — run another fix pass with specific guidance
  • Push commits directly — review re-runs automatically on push
    Updated by fullsend fix agent

@fullsend-ai-review

fullsend-ai-review Bot commented Sep 1, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 4:26 AM UTC · Completed 4:41 AM UTC

Commit: ae44e28 · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $4.77

fullsend-ai-review[bot]

This comment was marked as outdated.

@fullsend-ai-coder

fullsend-ai-coder Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

🤖 Finished Fix · ✅ Success · Started 4:43 AM UTC · Completed 4:48 AM UTC

Commit: ae44e28 · View workflow run →

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
@fullsend-ai-coder

Copy link
Copy Markdown
Contributor Author

🔧 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):

  1. CLI touchpoints section omits internal/cli/github.go which also defines a --runtime flag with a hardcoded valid-values string in newGitHubSetupCmd() (docs/contributing/runtime-implementation.md): Added a checklist item under the CLI section for internal/cli/github.go — update the --runtime flag description in newGitHubSetupCmd() to include the new runtime name.
  2. The registry.go checklist item duplicates existing numbered step 1 without acknowledging the redundancy (docs/contributing/runtime-implementation.md): Added parenthetical note '(mirrors step 1 above — listed here so the walkthrough is self-contained)' to the registry.go item to make the intentional redundancy explicit.

Tests: passed

Next steps:

  • /fs-review — request a re-review of the changes
  • /fs-fix <your instruction> — run another fix pass with specific guidance
  • Push commits directly — review re-runs automatically on push
    Updated by fullsend fix agent

@fullsend-ai-review

fullsend-ai-review Bot commented Sep 1, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 4:50 AM UTC · Completed 5:06 AM UTC

Commit: aa24dc1 · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $4.01

@fullsend-ai-review
fullsend-ai-review Bot dismissed stale reviews from themself September 1, 2026 05:06

Superseded by updated review

@fullsend-ai-review fullsend-ai-review Bot added the ready-for-merge All reviewers approved — ready to merge label Sep 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/docs User-facing documentation ready-for-merge All reviewers approved — ready to merge ready-for-review Agent PR ready for human review risk/moderate PR risk: moderate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expand runtime-implementation.md checklist with file-level consumer touchpoints

0 participants