Uh oh!
There was an error while loading. Please reload this page.
docs(bugbot): project context for the repo that decides whether checks passed (backend#1680) - #225
Merged
Merged
Conversation
…s passed (backend#1680) .github had no `.cursor/BUGBOT.md` — one of five repos without one — despite being public and holding the reusables ~120 callers consume at @main, plus the conformance contract itself. Written from this repo's actual defect history rather than generic advice. Nearly every real finding here is one shape: a guard that reports success it did not verify. The guide names the variants seen in this repo (empty response read as 'nothing found', `|| echo 0`, a grep in a pipefail pipeline returning 141, a required check that is path-filtered so it can never report, a soft-fail default on a required check), plus the two-protection-systems trap and the @main caller/callee ordering rule that turns a mistimed input into startup_failure. Also records the non-issues that were being re-raised: retired pii-gate contexts, the deliberate `strict: false`, and the long incident comments that are load-bearing rather than verbose. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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 freeto 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.
Why
.githubhad no.cursor/BUGBOT.md— one of the five repos without one (withe2e-test-agent,release-train,rfcs,claude-skills) — despite being public and holding the reusables ~120 callers consume at@main, plus the conformance contract itself.Written from this repo's actual defect history
Nearly every real finding here is one shape: a guard that reports success it did not verify. The guide names the variants that have actually occurred in this repo rather than describing the idea abstractly:
|| echo 0turning a failed call into a clean countgrep -qin apipefailpipeline where a real hit returns rc=141Plus the two traps specific to this repo:
bypass_actorsexists only on/rulesets/{id}, so an allowlist asserted from the per-branch endpoint asserts nothing.@main. A caller passing an input the@maincallee does not yet declare dies withstartup_failure— a job that never starts, not a red one.It also records the non-issues
Half of review churn is rediscovering a settled decision. Written down: retired
pii-gatecontexts lingering red, the deliberate fleet-widestrict: false(backend#1276), and the long incident comments — which are load-bearing, each one the reason a guard is written the awkward way it is, and should not be trimmed for brevity.Parent epic: backend#1680 (repo-hygiene scan, section A).
Note
Low Risk
Documentation-only addition with no runtime, CI, or security behavior changes.
Overview
Adds a new
.cursor/BUGBOT.mdso Bugbot has repo-specific review guidance for this public reusable-workflows repo.The guide focuses Bugbot on fail-open guards (success reported without a real check), required checks that cannot fail or report, reading only one of GitHub's two branch-protection systems, and caller/callee input ordering at
@main. It also lists known non-issues (retiredpii-gate, deliberatestrict: false, load-bearing incident comments) to cut review churn.Reviewed by Cursor Bugbot for commit d571455. Bugbot is set up for automated code reviews on this repo. Configure here.