Repository navigation
Conversation
jussielo-amd
left a comment
There was a problem hiding this comment.
Reviewed. Docs-only change (AGENTS.md, CONTRIBUTING.md), no runtime/CLI-facing impact.
Correctness: All 11 new factual claims (e2e test = false quirk, exact CI clippy invocation, cargo xtask e2e, license-header hook aborting vs. third-party-notices hook silently no-oping, etc.) were independently verified against the repo — all accurate. Fixes the four gaps it describes; a few other "rule with no named command" spots remain elsewhere in AGENTS.md (§3/§13, §6, §8, §12) — same defect class, out of scope here, good follow-up candidate.
Note: you already flagged it yourself, but the new e2e-cucumber clippy line uses --locked (matching CI) while the adjacent pre-existing workspace clippy line still doesn't, even though CI's version has it too — worth aligning whenever convenient.
UX: minor flow nits only — the new §3 paragraph sits between the topic sentence and the bullets it explains (slightly breaks the antecedent), and the AGENTS.md cross-reference in CONTRIBUTING.md lands mid-setup-section without a transition. Neither is misleading, just placement polish.
No blocking issues, CI green. Approving.
juhovainio
left a comment
There was a problem hiding this comment.
I reviewed this doc-only change against the actual repo config rather than just the prose, and every claim checks out.
tests/e2e-cucumber/Cargo.toml really does set test = false on the e2e test target, so cargo test --workspace --all-targets silently skips every scenario — confirmed that's the real gap this fixes. CI's workflow runs both cargo clippy --locked --workspace --all-targets and a separate cargo clippy --locked -p e2e-cucumber --test e2e, and the new line added to AGENTS.md's quality gate matches that second invocation byte-for-byte. HAWKEYE_VERSION: v7.0.0 is pinned in ci.yml as stated, and the cargo-tpn pre-commit hook does use --if-available, so a green local hook run genuinely doesn't guarantee the same result CI's --check invocation gives.
CI is green (the E2E lanes correctly no-op since this touches no code path). Approving.
nowycondro
left a comment
There was a problem hiding this comment.
🔴 Automated review · pr-review-watcher · d77c93b
Review — no blocking findings
Full review of the whole change (two files, 24 lines touched — read as a single pass; no fan-out needed given the size, per the review method's sizing guidance). No ticket named; the PR description is a self-contained bug report/fix for AGENTS.md's own quality-gate section, not tied to an external issue.
Blocking
None
Non-blocking
CONTRIBUTING.md's Test commands table still presents barecargo testas if it covers Rust testing —CONTRIBUTING.md:74
This PR adds a direct cross-reference fromCONTRIBUTING.md:57toAGENTS.md, whose newly-added text (AGENTS.md:200) explains, correctly (verified againsttests/e2e-cucumber/Cargo.toml'stest = falseon thee2etarget), thatcargo test --workspace --all-targetssilently skips every e2e scenario. TheCONTRIBUTING.mdtable two lines below the new cross-reference still lists the Rust test command as plaincargo testwith no such caveat. Pre-existing, not introduced by this diff, and softened by the table being followed by "Seedocs/testing.mdfor the full test guide" — but it is the same defect class this PR exists to fix, sitting in a file this PR already touches.
Confidence 85 · documentation · Fix: add a one-line caveat or a second row forcargo xtask e2eto the table, or point it atAGENTS.md§8.
Decisions for the author
- Two scope questions the author already raised in "Notes for reviewers" — tradeoff
(1) The newly addedcargo clippy --locked -p e2e-cucumber --test e2eline (AGENTS.md:193) carries--locked, matching CI byte-for-byte, while the adjacent pre-existingcargo clippy --workspace --all-targetsline (AGENTS.md:192) does not, even though CI's equivalent does. (2) Whether the e2e-cucumber clippy line belongs in this PR at all, versus being "adjacent" scope creep. Both are already surfaced by the author with a stated preference to keep the change narrow. Independently verified: keeping the second clippy line is well justified (the sametest = falseroot cause this PR documents also excludes the e2e harness from the first clippy invocation), and the--lockedmismatch on the untouched line is pre-existing. Neither choice is wrong — confirm the narrow-scope call stands, or fold the alignment into this PR.
Positive signals
- Every new factual claim is independently checkable against the repo's own configuration, and all of them check out on re-tracing:
tests/e2e-cucumber/Cargo.toml'stest = falsecomment,.github/workflows/ci.yml's exact two clippy invocations andHAWKEYE_VERSIONpin,.pre-commit-config.yaml's--if-availableon the notices hook and the plainsystem-language license-header hook, anddocs/testing.md's explicit warning that-n/--tagsbypass the suite's custom expectation/applicability resolver for lifecycle scenarios. - The new §8 bullets state why each command is needed rather than just asserting it (e.g., "that same
test = falsealso excludes the e2e harness fromcargo clippy --workspace --all-targets"), which is exactly the reasoning an agent-instruction file needs to extend a rule to a case not explicitly enumerated.
Deployment notes
None — documentation-only change, no build, runtime, or CI-configuration impact. CI confirms this: all GPU-dependent E2E lanes correctly report SKIPPED rather than SUCCESS or FAILURE.
What this covered
Full diff read completely: AGENTS.md and CONTRIBUTING.md, both in full (not just the changed hunks), against commits 03c46b58…d77c93bd (merge-base of the PR head with the current main tip, since main has moved on unrelated commits since this PR's base). Cross-checked every command and factual claim the diff adds against its actual source: tests/e2e-cucumber/Cargo.toml, .github/workflows/ci.yml, .pre-commit-config.yaml, docs/testing.md, tests/e2e-cucumber/README.md, and xtask/src/e2e.rs. Reviewed as an AI-instruction-file change per the ai-instruction-quality checklist (no phantom commands, no broken cross-references, examples accurate, reasoning given alongside each rule). Checked live CI via gh pr view --json statusCheckRollup: all required checks SUCCESS, GPU lanes SKIPPED as expected for a docs-only change. Checked commit history for the two files: single, well-formed Conventional-Commits-style commit, no noise to squash.
Did not run: "prior changes" pass — did not read this PR's review discussion or threads (out of scope per review instructions); no other open PRs against these two files were found to cross-check. History pass beyond git log on the two files was not otherwise applicable (docs-only, no code to blame against logic). Not reconciled against any discussion on this PR.
juhovainio
left a comment
There was a problem hiding this comment.
Review — no blocking findings
Full review of the whole change (two files, 23 additions/1 modification). No ticket named; the PR description is a self-contained bug report/fix for AGENTS.md's own quality-gate section.
Blocking
None
Non-blocking
CONTRIBUTING.mdanddocs/testing.mdstill present barecargo test/cargo clippy --workspace --all-targetsas if they cover Rust testing and linting —CONTRIBUTING.md:74,docs/testing.md:16,docs/testing.md:22
This PR adds a direct cross-reference fromCONTRIBUTING.md:57toAGENTS.md, whose newly-added §8 text correctly explains, verified againsttests/e2e-cucumber/Cargo.toml'stest = falseon thee2etarget, thatcargo test --workspace --all-targetssilently skips every e2e scenario (and the adjacentcargo clippy --workspace --all-targetsmisses the harness too).CONTRIBUTING.md's "Test commands" table anddocs/testing.md's "Local Verification" section — the two other places a contributor looks for these exact commands — still show the incomplete recipe with no caveat. Pre-existing, not introduced by this diff, but the same defect class this PR exists to fix, now a single cross-reference hop away from where it's named.
Confidence 85 · mechanical · Fix: add a one-line caveat or cross-reference toAGENTS.md§8 at both locations.
Decisions for the author
- Two scope questions already raised in "Notes for reviewers" — tradeoff
(1) The newcargo clippy --locked -p e2e-cucumber --test e2eline matches CI byte-for-byte, while the adjacent pre-existingcargo clippy --workspace --all-targetsline lacks--lockedeven though CI's equivalent has it. (2) Whether the e2e-cucumber clippy line belongs in this PR versus being adjacent scope creep. Independently verified: CI (.github/workflows/ci.yml) does run both clippy invocations exactly as now documented, and the--lockedmismatch is on an untouched, pre-existing line. Neither choice is wrong — confirm the narrow-scope call stands, or fold the alignment in.
Positive signals
- Every new factual claim is independently checkable against the repo's own configuration and holds up:
tests/e2e-cucumber/Cargo.toml'stest = false,.github/workflows/ci.yml's two exact clippy invocations andHAWKEYE_VERSIONpin,.pre-commit-config.yaml's--if-availableon the notices hook versus the plainlanguage: systemlicense-header hook,xtask/src/e2e.rs's argument-forwarding to the cucumber CLI, anddocs/testing.md's explicit warning that--tags/-nbypass the suite's custom applicability/expectation resolver. - New §8 bullets explain why each command is needed rather than just asserting it, which is exactly the reasoning an agent-instruction file needs to extend a rule to an unenumerated case.
Deployment notes
None — documentation-only change, no build, runtime, or CI-configuration impact.
What this covered
Full diff read completely: AGENTS.md and CONTRIBUTING.md, both in full, against 03c46b58…d77c93bd (merge-base of the PR head with current main). Cross-checked every new command and factual claim against its source: tests/e2e-cucumber/Cargo.toml, .github/workflows/ci.yml, .pre-commit-config.yaml, docs/testing.md, xtask/src/e2e.rs. Reviewed as an AI-instruction-file change (no phantom commands, no broken cross-references, reasoning given alongside each rule). Checked live CI via the GitHub API: all required checks SUCCESS, GPU-dependent E2E lanes SKIPPED as expected for a docs-only change. Checked commit history: single well-formed commit, no overlapping recent edits to either file.
Did not run: history/prior-changes passes beyond git log on the two files (docs-only, nothing to blame against logic; no other open PRs found touching these files). Not reconciled against this PR's existing review discussion.
🤖 Automated by an AI agent
| cargo install cargo-about@0.9.1 --locked --features cli # optional, for THIRD_PARTY_NOTICES.txt | ||
| ``` | ||
|
|
||
| Agents working in this repository additionally follow `AGENTS.md`. |
There was a problem hiding this comment.
Non-blocking, pre-existing: this new cross-reference points at AGENTS.md, whose newly-added §8 text correctly explains that tests/e2e-cucumber's test = false on the e2e target makes cargo test --workspace --all-targets silently skip every e2e scenario (verified in tests/e2e-cucumber/Cargo.toml). The "Test commands" table 17 lines below this (CONTRIBUTING.md:74) still lists the Rust test command as plain cargo test with no such caveat, and docs/testing.md:16/:22 show the same gap for cargo test --workspace --all-targets / cargo clippy --workspace --all-targets -- -D warnings. Same defect class this PR exists to fix, now one cross-reference-hop away. Confidence 85 · mechanical · Fix: add a one-line caveat or cross-reference to AGENTS.md §8 at both locations.
There was a problem hiding this comment.
Addressed in the reworked head (7179396). The sentence after the Test commands table in CONTRIBUTING.md now links AGENTS.md section 8 as the minimum quality gate and says the table lists only some of its commands, and step 4 of "Making changes" points at the same gate. In docs/testing.md, Local Verification no longer carries its own cargo test and cargo clippy commands and points at section 8 instead, and the "CI test selection" text no longer recommends plain cargo test --workspace --all-targets as the full local verification.
AGENTS.md requires user-observable behavior changes to be covered by a Gherkin scenario under tests/e2e-cucumber/, but the quality gate it prescribed ran none of them: the e2e target sets `test = false`, so `cargo test --workspace --all-targets` skips every scenario and still reports success, and the same setting leaves the harness out of `cargo clippy --workspace --all-targets`. AGENTS.md section 8: the gate gains `prek run --all-files`, the package-scoped e2e harness clippy that CI runs, `cargo xtask tpn --check` and `cargo xtask e2e`. Both clippy lines take `--locked` and come first, as in CI. The notes under it say why `cargo test` is not enough; that a green `cargo xtask e2e` does not show a gated scenario ran (a plain run lists each skipped scenario with its reason in platform.json) and that a filtered run, or one with `ROCM_CLI_BINARY` set, is not the gate; that some `prek` hooks rewrite files, so the lines above it are re-run when it changed anything; that a hook which skips or lacks its tool is a check that did not run, and that prek shows a skipped hook as passed unless it is verbose, as `powershell-script-analyzer` is not; and why the notices check is its own line: the `cargo-tpn` hook inside prek skips silently without the pinned `cargo-about`, where the command fails loudly. The notes link the code behind the platform.json, `ROCM_CLI_BINARY` and `cargo xtask tpn --check` claims. Section 3 gains one line pointing at `cargo xtask e2e` in section 8. CONTRIBUTING.md: the sentence after the test table links section 8 of AGENTS.md as the minimum quality gate and says the table lists only some of its commands; step 4 of "Making changes" says to run at least that gate, plus the suites relevant to the change; the `cargo-about` install comment and the sentence above it say the section 8 gate needs the tool. docs/testing.md: the Local Verification section drops its copies of the `cargo test` and `cargo clippy` commands and points at the gate instead, and the "CI test selection" section no longer tells readers to keep using `cargo test --workspace --all-targets` for a full local verification and says the gate does not use `affected`. Signed-off-by: Teemu Kuusisto <teemu.kuusisto@amd.com>
d77c93b to
7179396
Compare
|
I reworked this PR since the heads you reviewed (
The PR title and body are updated to match. |
Security scan found no critical or high findings on lines changed by this pull requestView the security scan run for complete reports. “New” means the finding is located in a changed file on an added or modified line; it is not a base-versus-head findings delta. |
AGENTS.mdrequires user-observable behaviour changes to be covered by a Gherkin scenario, but the quality gate it prescribed runs none of them.What was wrong
cargo test --workspace --all-targets,cargo clippy --workspace --all-targetsandcargo xtask smoke. Thee2etarget oftests/e2e-cucumbersetstest = false, socargo testandcargo nextestskip every scenario and still report success. Onlycargo xtask e2eruns them, and the gate never named it.cargo xtask tpn --check) is not in the gate. Thecargo-tpnhook insideprekskips silently without the pinnedcargo-about, where the command fails loudly, so a green local run did not mean what CI means.What changed
AGENTS.mdsection 8: the gate gainsprek run --all-files, the package-scoped e2e harness clippy,cargo xtask tpn --checkandcargo xtask e2e. Both clippy lines take--lockedand come first, as in CI. The notes under it explain whycargo testis not enough, that a greencargo xtask e2edoes not show a gated scenario ran, that a filtered run or one withROCM_CLI_BINARYset is not the gate, that someprekhooks rewrite files, and that a hook which skips or lacks its tool is a check that did not run (prek shows a skipped hook as passed unless the hook is verbose).AGENTS.mdsection 3 gains one line pointing atcargo xtask e2ein section 8.CONTRIBUTING.md: the sentence after the test table links section 8 as the minimum quality gate, step 4 of "Making changes" says to run at least that gate, and thecargo-aboutinstall comment says the section 8 gate needs the tool.docs/testing.md: Local Verification drops its own copies of thecargo testandcargo clippycommands and points at section 8, and the "CI test selection" text no longer tells readers to keep usingcargo test --workspace --all-targetsfor a full local verification.Each fact has one owning place: section 8 owns the gate, and the other files point to it.
Test plan
Documentation only, so no scenario applies: no behaviour a CLI user can observe changes.
Checked by reading each claim against the source it describes: the e2e target's
test = false, both clippy invocations in the CI workflow,PlatformManifestande2e_binaries_fromfor theplatform.jsonandROCM_CLI_BINARYnotes,runin thetpnmodule for the hook and the direct command, and the.pre-commit-config.yamlhook definitions. The commands were not run on this head;prek(including the link check) and the docs build run in CI.Checklist
tests/e2e-cucumber/expectations.tomlfor the fixed ticket ID and removed/narrowed any now-stale xfail rows. Not applicable: documentation only, no code behaviour changes, andexpectations.tomlis untouched by this PR.Scope
CONTRIBUTING.mdalready owns what the tools need and how each hook behaves without them.tests/e2e-cucumber/Cargo.toml,cargo xtask e2e --helpwording and the skip-reason strings.