docs(#6197): document Fn suffix convention for injectable function variables - #6200
Conversation
|
🤖 Finished Review · ✅ Success · Started 6:07 PM UTC · Completed 6:19 PM UTC Commit: |
Site previewPreview: https://910b3f06-site.fullsend-ai.workers.dev Commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ReviewFindingsMedium
Low
Previous runReviewFindingsMedium
Low
Labels: PR modifies documentation under docs/contributing/ about Go code conventions |
|
/fs-fix rebase and resolve conflicts |
|
🤖 Finished Fix · ❌ Failure (post-script /home/runner/work/fullsend/fullsend/.fullsend/.fullsend-cache/resources/sha256/1704f826be06352c5aa727ca7a68e6bc3db1837e9743e1727323664169eefe2b/scripts/post-fix.sh failed: exit status 1) · Started 8:45 AM UTC · Completed 8:50 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $1.54 |
|
The fix agent completed, but the post-fix script failed before finishing. Workflow run: https://github.com/fullsend-ai/fullsend/actions/runs/32949230655 Details: |
1365be4 to
7467e96
Compare
|
🤖 Finished Review · ✅ Success · Started 10:13 AM UTC · Completed 10:29 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $3.58 |
|
Risk Assessment: moderate (2/5) DetailsMinimal-risk documentation-only PR adding 11 lines to an existing contributing guide. Tier 2 slightly elevated due to high churn on go-code.md (21 commits in 30 days, 6 authors), but offset by trivial change size, bot author, and precise issue scope alignment. |
…riables Add an "Injectable function variables (test seams)" section to docs/contributing/go-code.md documenting the naming and usage convention for package-level function variables used as test seams. The convention (XxxFn suffix, default to real impl, doc comment pattern, t.Cleanup restoration) has 9+ instances with zero violations but was previously undocumented, causing agents to infer the pattern from code rather than referencing written guidance. Note: pre-commit could not run in sandbox (network restriction). Manual verification of pre-commit is required. Closes #6197
7467e96 to
d06fe96
Compare
|
🤖 Finished Review · ✅ Success · Started 1:16 PM UTC · Completed 1:31 PM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $3.12 |
|
Review skipped — this PR is already merged. The Posted by fullsend pre-review check |
|
🤖 Finished Retro · ✅ Success · Started 1:17 PM UTC · Completed 1:29 PM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $4.13 |
Retro: PR #6200 — Document Fn suffix conventionTimeline
Key findingsDocumentation merged with known inaccuracies. The review agent correctly identified that the doc comment guidance is inaccurate (says comments should start with "Override in tests to..." but Go convention and all codebase examples start with the variable name). The review also noted the documentation omits unexported Evidence for existing issues:
Autonomy observationThe review agent's accuracy findings were correct and caught issues the human review did not address. This supports the case for the review agent having stronger gating authority on accuracy-class findings for documentation PRs — medium-severity accuracy findings could block merge rather than posting as informational comments. This aligns with #6018. Proposals filed
|
|
Review skipped — this PR is already merged. The Posted by fullsend post-review check |
Summary
Documents the
XxxFnsuffix naming convention for injectable function variables (test seams) indocs/contributing/go-code.md. This convention has 9+ consistent instances acrossinternal/sandbox/andinternal/dispatch/cf/but was previously undocumented, causing agents to infer it from code patterns rather than referencing written guidance.Changes
docs/contributing/go-code.mdafter the "Concurrency testing" sectionFnsuffix, default to real implementation, "Override in tests to..." doc comment pattern, andt.CleanuprestorationRetrySleepFn,BuildWASMFn,CopyWASMExecFn)Testing
Checklist
!for breaking changes)Closes #6197
Post-script verification
agent/6197-doc-fn-suffix-convention)ed0deb850458a4eb2107b51298a569c7503295db..HEAD)