docs(agents): lead the Gates section with make targets and the PTY progress-bar caveat - #1795
Merged
Conversation
…ogress-bar caveat The raw cargo test invocation was stale (the Makefile runs nextest) and saved ws.script runs are PTY-backed, so a raw cargo nextest run floods its output buffer with progress-bar redraws unless --show-progress none and CARGO_TERM_PROGRESS_WHEN=never are passed. Point at make check / test / gate first and keep the raw equivalents with that caveat. Agent-Id: agent-be1f9de1-55b4-4320-a704-77cd94a365ed
🤖 Augment PR SummarySummary: Updates the contributor gate instructions to lead with the monorepo’s supported 🤖 Was this summary useful? React with 👍 or 👎 |
![augmentcode[bot]](https://avatars.githubusercontent.com/in/1027498?s=60&v=4){kind=small}
--show-progress is nextest-only; CARGO_TERM_PROGRESS_WHEN applies to all three raw cargo invocations. Addresses a review comment on #1795. Agent-Id: agent-be1f9de1-55b4-4320-a704-77cd94a365ed
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
1 participant
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
The "Gates — keep them green" section listed
cargo testwhile the monorepoMakefilerunscargo nextest run, and it presented the raw commands before the supportedmaketargets. Agents following the raw invocation inside a savedws.script(PTY-backed) got nextest's progress bar redrawn into the captured buffer — one full run produced ~530 KB of cursor-control sequences and overflowed an agent's context.What
Docs only. Lead the section with
make check/make test/make gate, keep the raw equivalents second with the invocation the Makefile actually runs (cargo nextest run --workspace --show-progress none), and add the PTY caveat: raw runs must pass--show-progress noneandCARGO_TERM_PROGRESS_WHEN=never(themaketargets already do). Section length unchanged.Companion monorepo PR that makes the
maketargets quiet by default: intent-hq/intent#4733.