test: name guarding PRs in regression-test docstrings#333
Merged
Conversation
AGENTS.md requires regression tests to name the PR/commit they guard in the docstring. Several regression tests added in recent PRs cited only a GitHub issue (or an audit finding) without the guarding PR. Update the docstrings to follow the AGENTS.md convention, keeping the existing issue/finding references. Fixes review-bot comments repeated across PRs #308, #309, #319, #320, #327, #329.
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 free
to 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.
Summary
AGENTS.mdrequires: "Regression tests must name the PR/commit they guard in the docstring (e.g.Guards the fix from PR #198 against the regression introduced by PR #193)."The review bots (Codex P1 / Devin) flagged this convention violation repeatedly across PRs #308, #309, #319, #320, #327, and #329 — the regression tests added there cited only a GitHub issue (
Guards issue #NNN), an audit finding, or no reference at all, instead of naming the guarding PR.This is a docstring-only, behavior-preserving change. No test logic or assertions were touched. Existing issue/finding references are kept alongside the new PR reference.
Docstrings fixed
tests/test_trial_install_agent_timeout.py::test_install_agent_passes_effective_task_path_to_deploy_skills→ PR test: guard issue #229 — deploy_skills receives effective task path #308 (keeps issue deploy_skills double-deploys when skills_dir is set, causing 'cannot overwrite directory "/skills/..."' on container cp #229)tests/test_sandbox_hardening.py::test_verifier_config_keeps_pytest_plugins_from_toml→ PR fix(verifier): restore [verifier] pytest_plugins task.toml field (#192 bug 2) #309 (keeps issue 14 infrastructure bugs found in SkillsBench Trial 1 audit — verifier, permissions, provisioning #192 bug 2)tests/test_llm_judge.py—TestCallJudgeProviderFallback,TestCallAnthropicContent,test_likert_criterion→ PR fix(rewards): three rewards-code audit findings #319tests/test_job.py/tests/test_metrics.py/tests/test_skill_eval.py— audit Finding 6/7 tests → PR fix: disjoint error/verifier_error result buckets + skill_eval glob collision #320tests/test_usage_proxy.py—test_no_proxy_for_daytona_remote_sandbox,test_daytona_runtime_retired_when_environment_unreachable→ PR fix(daytona): skip host telemetry proxy for unreachable remote sandboxes #327tests/test_provider_runtime.py::TestBedrockProxyRemoteSandbox→ PR fix(bedrock): fail fast for Bedrock models on unreachable remote sandboxes #329Verification
uv run ruff format --check src tests— passesuv run ruff check .— passesuv run ty check src/— passesuv run python -m pytest tests/— 1310 passed, 27 skipped (unchanged; docstring-only)Note
Low Risk
Low risk: docstring-only edits in test files with no behavioral or assertion changes.
Overview
Aligns regression-test docstrings with
AGENTS.mdby adding explicit “Guards the fix from PR #…“ references (while keeping existing issue/audit identifiers) across several test modules.No test logic, assertions, or production code is modified; only docstring wording/formatting is updated.
Reviewed by Cursor Bugbot for commit 9539002. Bugbot is set up for automated code reviews on this repo. Configure here.