Add a few engineering rules to the agent docs#5625
Merged
Conversation
Add a small set of proven, impersonal engineering rules that recurred in CLI/SDK review work but were not yet captured in the repo's agent docs: - AGENTS.md: don't copy config.Config by value (copylocks); open URLs via libs/browser not pkg/browser; use libs/auth.WorkspaceIDHeaders for raw workspace-routed calls; //deadcode:allow directive; ST1005 (no trailing punctuation in error strings). - .agent/rules/style-guide-go.md: json.Decoder.UseNumber() when round-tripping API responses (int64 > 2^53 corruption); encoding/csv UseCRLF rewrites embedded newlines inside quoted fields. - .agent/rules/testing.md: MSYS_NO_PATHCONV for POSIX path args on Windows; EnvMatrix.<VAR> = [] drops a matrix var; out.test.toml block-format regen. Co-authored-by: Isaac
simonfaltum
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
simonfaltum
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
janniklasrose
approved these changes
Jun 17, 2026
Collaborator
Integration test reportCommit: 9cc02ca
26 interesting tests: 15 SKIP, 6 RECOVERED, 5 flaky
Top 25 slowest tests (at least 2 minutes):
|
Collaborator
Integration test reportCommit: b188998
464 interesting tests: 372 MISS, 54 FAIL, 27 RECOVERED, 7 KNOWN, 2 PANIC, 2 SKIP
Top 50 slowest tests (at least 2 minutes):
|
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
3 participants
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
A few durable engineering rules that come up repeatedly in this repo weren't captured in the agent docs yet. This adds them so they're applied consistently.
Changes
Docs only, no code change. Adds rules to three existing files:
AGENTS.md: don't copyconfig.Configby value (copylocks); open URLs vialibs/browser, notgithub.com/pkg/browser; set routing headers vialibs/auth.WorkspaceIDHeaderson hand-written workspace-routed calls; the//deadcode:allowdirective; error strings must not end with punctuation (ST1005)..agent/rules/style-guide-go.md: usejson.Decoder+UseNumber()when round-tripping API responses (avoids int64 > 2^53 corruption and key reordering);encoding/csvUseCRLFalso rewrites embedded newlines in quoted fields..agent/rules/testing.md:MSYS_NO_PATHCONVfor POSIX path args on Windows;EnvMatrix.<VAR> = []drops a matrix variable; regenerating block-formatout.test.toml.Test plan
./task fmt-q,./task checks,./task lint-qall passThis pull request and its description were written by Isaac.