Repository navigation
docs: streamline and verify AGENTS.md guidance - #1595
Conversation
Vulnerable dependencies0 advisories across 0 libraries need attention, 3 accepted. AcceptedListed in
|
| Advisory | CVE | Fixed in | Summary |
|---|---|---|---|
| GO-2025-3684 | — | no fix yet | Cosmos EVM Allows Partial Precompile State Writes in github.com/cosmos/evm |
github.com/pion/dtls/v2
In use: v2.2.12 — reached from cli
| Advisory | CVE | Fixed in | Summary |
|---|---|---|---|
| GO-2026-4479 | CVE-2026-26014 | no fix yet | Usage of random nonce generation with AES GCM ciphers risks leaking the authentication key in github.com/pion/dtls |
golang.org/x/crypto
In use: v0.57.0 — reached from cli, e2e
| Advisory | CVE | Fixed in | Summary |
|---|---|---|---|
| GO-2026-5932 | — | no fix yet | The golang.org/x/crypto/openpgp package is unmaintained, unsafe by design, and has known security issues |
From make vulncheck-json on this run: logs.
[Low impact] The changes reach repository agent guidance and documentation workflows, not application runtime behavior. The PR appears safe to merge, with a non-blocking correction to the PostgreSQL test guidance. Findings
SummaryStreamlines agent guidance and narrows reference regeneration instructions to changes that affect the documented surface.
Acknowledged follow-ups: gjermundgaraba explicitly deferred the generated-store path-filter gap and the absence of a Reviews (1) · Last reviewed commit: "little cleanly" · Reviewed by Greptile |
Signed-off-by: Gjermund Garaba <gjermund@garaba.net>
Signed-off-by: Gjermund Garaba <gjermund@garaba.net>
Signed-off-by: Gjermund Garaba <gjermund@garaba.net>
Replace the CLI test imperatives with facts about the module and e2e execution modes, trim the CLI command conventions to the two that are not visible in the code, map the e2e README pointer to named sections, replace harness literals with the helpers that define them, drop the compile-enforced import prohibition, and align the proto regeneration wording between the server and proto files. Signed-off-by: Gjermund Garaba <gjermund@garaba.net>
Point the root file at nested area guidance so Codex sessions started at the repository root find it, state the repo-wide facts an agent cannot infer (Go module boundaries, SPDX lint targets, aggregate check target, disposable Docker containers), move the mock regeneration rule to the CLI scope where every mocked interface is covered, name the e2e matrix targets, state the Postgres test gate once, fold the compiler-enforced two-backend line into the Repository bullet, and delete the unreferenced cli/CONTEXT.md glossary. Signed-off-by: Gjermund Garaba <gjermund@garaba.net>
Remove facts that the code, generated-file headers, Makefiles, or the adjacent README already state where an agent would meet them: the CLI command conventions documented in main.go, the server codegen paragraph duplicated in proto/, the module inventory, the sqlc and refgen prerequisites, the generated-page marker warning, the e2e setup sequence shown in the README, and helper names visible in the providers. Keep what is silent when wrong: the fast-mode Besu skip, the mock regeneration CI does not run, the matrix check the test target does not run, the container labels cleanup depends on, and the Repository placement the compiler does not check. Correct the README sentence on provider requirements that the cut e2e clause had been patching. Signed-off-by: Gjermund Garaba <gjermund@garaba.net>
Signed-off-by: Gjermund Garaba <gjermund@garaba.net>
Signed-off-by: Gjermund Garaba <gjermund@garaba.net>
Signed-off-by: Gjermund Garaba <gjermund@garaba.net>
GuardPostgresTests checks only TEST_POSTGRES; NewPostgresContainer then requires Docker and fails the run rather than skipping it. Also fix a typo in the root permission line. Signed-off-by: Gjermund Garaba <gjermund@garaba.net>
Signed-off-by: Gjermund Garaba <gjermund@garaba.net>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1595 +/- ##
=======================================
Coverage 43.19% 43.19%
=======================================
Files 145 145
Lines 15606 15606
=======================================
Hits 6741 6741
Misses 8332 8332
Partials 533 533
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Signed-off-by: Gjermund Garaba <gjermund@garaba.net>
b2326e0 to
a0dd63c
Compare
Description
With agents being gooder, we need much less guidance and stuff in AGENTS.md. Saves context, and makes it less likely for information to go stale.
🤖: Streamlines the
AGENTS.mdfiles so they carry only guidance an agent cannot infer from the code, the Makefiles, generated-file headers, or the adjacent READMEs, and verifies every remaining fact against the tree.What changed, in order:
docs/6-ibc-cli/tools/AGENTS.mdfrom 224 lines to a short procedure. Removedcli/internal/config/AGENTS.md(code-ordering rules) and thecli/CLAUDE.mdsymlink, which made Claude Code skip the root file for sessions started incli/.refgen.pyfrom "after changing cli/, proto/ or gen/ before opening a PR" to "when changing commands, configuration, APIs, or cited behavior".REFERENCE.mdnow states that--planand--reportdo not run citation checks.AGENTS.mdfrom the repository root down to the working directory. Added the rules that are silent when wrong:make codegen-mocks(CI does not regenerate mocks),make -C e2e check-matrix(the test target does not run it), theTEST_POSTGRESgate, the defaultE2E_MODE=fastskipping Besu-requiring tests, and permission to run the Docker-backed tests without asking. Deleted the unreferencedcli/CONTEXT.mdglossary.cli/cmd/ibc/AGENTS.md(both rules are stated inmain.go), cut the module inventory, the server codegen paragraph, helper names visible in the providers, and the setup sequence shown in the e2e README. Fixed the e2e README sentence on provider requirements that one cut line had been patching.Most critical to review:
AGENTS.md,cli/AGENTS.md,docs/6-ibc-cli/tools/AGENTS.md,e2e/AGENTS.md,cli/internal/store/AGENTS.md.Two follow-ups surfaced by the reviews are not in this PR: the
verify-codegenpath filter does not cover hand edits to generated store files on pull request runs, and no workflow runsmake lint-license.closes: n/a (agent guidance cleanup, no tracking issue)
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
make lint-licensepasses)docs/) if anything is changed.godoccomments if relevant. (n/a: no Go API change)Files changedin the GitHub PR explorer.🤖 Generated with Claude Code