Skip to content

docs: add repository agent guidance#52

Merged
frahlg merged 1 commit into
mainfrom
codex/add-agents-guidance
Jul 15, 2026
Merged

docs: add repository agent guidance#52
frahlg merged 1 commit into
mainfrom
codex/add-agents-guidance

Conversation

@frahlg

@frahlg frahlg commented Jul 15, 2026

Copy link
Copy Markdown
Member

What changed

Adds the repository-level AGENTS.md with Miranda's naming, layout, and non-negotiable security/interop invariants.

Why

Future automated changes should preserve the blind-relay boundary, Go/JS byte compatibility, passkey-derived owner identity, and the existing Go module path.

Impact

Documentation and contributor guidance only; no runtime or release artifacts change.

Validation

  • staged diff contains only AGENTS.md
  • git diff --cached --check passed
  • no runtime tests required for a documentation-only change

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e0c23a8a44

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread AGENTS.md
- Go and JS crypto MUST stay byte-identical — `testdata/` vectors are the gate.
After changing any handshake/derivation code, run `cd go && go test ./...` and
`cd web && npm test`; if vectors legitimately change, regenerate with
`UPDATE_VECTORS=1 go test ./internal/noise/ -run TestInteropVectorsStable`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Broaden vector regeneration guidance

For changes to pairing or owner-identity derivation, this command only regenerates the Noise KK and legacy owner vectors from go/internal/noise/interop_test.go; other byte-compatibility fixtures are generated by separate tests such as go/internal/pairing/interop_test.go::TestPairInteropVectorsStable and go/internal/identity/signer_test.go::TestIdentityDerivationVector. If an agent follows this AGENTS.md instruction after a legitimate change in those areas, it will leave stale testdata and break the Go/JS parity tests, so this should either list the relevant vector update commands or describe running the package-specific generator for the code being changed.

Useful? React with 👍 / 👎.

@frahlg frahlg merged commit 33230bd into main Jul 15, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant