Skip to content

docs(#7402): document silent-fallback error swallowing - #7404

Open
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/7402-silent-fallback-error-docs
Open

fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/7402-silent-fallback-error-docs

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

Summary

Document the silent-fallback error-swallowing anti-pattern in docs/contributing/go-code.md so new fallback-on-error paths classify unexpected failures instead of treating every error as a successful downgrade.

Related Issue

#7402 (filed from the extra review/fix cycle on PR #7342).

Changes

  • Add Classify errors before a degraded fallback under Error handling and naming conventions, modeled on the existing Timeout() bool / context.DeadlineExceeded entry.
  • WRONG/CORRECT examples, forge.IsTransient as the canonical classifier, and the GitLab postInlineComments / postDiffDiscussion / getMergeRequestDiffRefs worked example from PR feat(#7328): post GitLab review findings as inline discussions #7342.
  • Reviewer guidance: flag unclassified degraded fallbacks as a medium-severity finding.

Testing

  • Docs-only change; no Go tests.
  • lychee --offline --include-fragments on the edited file: 0 errors.
  • ./hack/lint-docs-links passed.
  • Secret scan passed.

Checklist

  • PR title follows Conventional Commits (correct type, ! for breaking changes)
  • Commits are signed off (DCO) — human and human-directed agent sessions only (autonomous agent commit; DCO exempt)
  • I wrote this contribution myself and can explain all changes in it

Closes #7402

Post-script verification

  • Branch is not main/master (agent/7402-silent-fallback-error-docs)
  • Secret scan passed (gitleaks — 7e429a12e61a9f7b25b6f29b03094998328cddad..HEAD)
  • PR body secret scan passed (gitleaks — no-git)

Add a subsection under Error handling and naming conventions in
docs/contributing/go-code.md for the classify-before-fallback
anti-pattern. Fallback-on-error paths must distinguish the expected
trigger from unexpected or transient failures and log or surface the
unexpected case, matching forge.IsTransient usage in the GitLab MR
inline-comment helpers from PR #7342.

Reviewers should flag unclassified degraded fallbacks as medium
severity, same bar as the Timeout()/DeadlineExceeded pitfall.

Closes #7402
@fullsend-ai-coder
fullsend-ai-coder Bot requested a review from a team as a code owner September 17, 2026 14:07
@fullsend-ai-coder fullsend-ai-coder Bot added the ready-for-review Triggers review agent dispatch label Sep 17, 2026
@fullsend-ai-review

Copy link
Copy Markdown

🤖 Review · ⚠️ Cancelled · Ended 2:08 PM UTC

Commit: 0ccd318 · View workflow run →

@fullsend-ai-review

fullsend-ai-review Bot commented Sep 17, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 2:10 PM UTC · Completed 2:27 PM UTC

Commit: 0ccd318 · View workflow run →

Runtime: pi · Model: sonnet → claude-sonnet-5 · Effort: high · Cost: $2.28

@github-actions

Copy link
Copy Markdown

Site preview

Preview: https://449a7046-site.fullsend-ai.workers.dev

Commit: 0ccd318c7109c3ea18e4847330e70ef68a82728a

@codecov

codecov Bot commented Sep 17, 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 17, 2026
@fullsend-ai-review

Copy link
Copy Markdown

Risk Assessment: moderate (2/5)

Details

Docs-only, single-file, bot-authored PR closely matching a freshly-filed low-priority issue with no risk labels (Tier1/Tier3 average 1.0), but the target file has volatile git history (high 30-day churn, broad author contention) pulling the 30%-weighted Tier2 average to 3.0; weighted composite rounds to a moderate score of 2.

@fullsend-ai-review

Copy link
Copy Markdown

Looks good to me

@fullsend-ai-review fullsend-ai-review Bot added the ready-for-merge All reviewers approved — ready to merge label Sep 17, 2026

This branch was successfully deployed

2 active deployments
site-preview 0ccd318c Deployed Sep 17, 2026 by github-actions[bot]
dev 0ccd318c Deployed Sep 17, 2026 by fullsend-ai-coder[bot] via behaviour #13104
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-merge All reviewers approved — ready to merge ready-for-review Triggers review agent dispatch risk/moderate PR risk: moderate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Codify the silent-fallback error-swallowing anti-pattern in docs/contributing/go-code.md

0 participants