xmtpxmtp/libxmtp/.github/workflows/AGENTS.md

libxmtp / workflows

AGENTS.md127 starsChanged 11 days agoMITView on GitHub

Validate edits with dev/nix-shell 'just lint-config' and dev/nix-shell 'just test dev'. - Edit .github/ci-suites.yml, then run dev/nix-shell 'python3.11 dev/ci-suites generate' and commit its generated JSON and ci.yml. Never edit ci.yml by hand. Read CI selection when changing filters, tiers, gates, runners, or the RN device chain. - Preserve required gate names Lint and Test and failure on skipped selected blocking suites. Keep native_backend, swift, and example-app Nix path groups current when their inputs change. - Keep advisory RN device jobs…

Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,439 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository21 other files it gives its agents.
- AGENTS.mdAGENTS.md
- docs/AGENTS.mdAGENTS.md
- nix/AGENTS.mdAGENTS.md
- proto/AGENTS.mdAGENTS.md
- sdks/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/workflows/CLAUDE.mdCLAUDE.md
- nix/CLAUDE.mdCLAUDE.md
- proto/CLAUDE.mdCLAUDE.md
- sdks/CLAUDE.mdCLAUDE.md
- authoring-specsSkill
- check-ciSkill
- checking-spec-complianceSkill
- reviewing-specsSkill
- smoke-checkSkill
- working-with-nixSkill
- working-with-worktreesSkill
- writing-agent-docsSkill
- writing-rustSkill
- writing-rust-testsSkill
- writing-typescriptSkill

The file

We split this AGENTS.md into the rules it gives an agent

3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Distinctive:
Keep advisory RN device jobs and warm sets out of non-RN post-merge dependencies.
line 13
Very specific:
Every setup-nix/setup-js call declares the same cache mode.
line 14
Very specific:
Keep full Nix build logs off by default.
line 27

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

AGENTS.md

GitHub workflows

Validate edits with dev/nix-shell 'just lint-config' and dev/nix-shell 'just test dev'.

Edit .github/ci-suites.yml, then run dev/nix-shell 'python3.11 dev/ci-suites generate' and commit its generated JSON and ci.yml. Never edit ci.yml by hand. Read CI selection when changing filters, tiers, gates, runners, or the RN device chain.
Preserve required gate names Lint and Test and failure on skipped selected blocking suites. Keep native_backend, swift, and example-app Nix path groups current when their inputs change.
Keep advisory RN device jobs and warm sets out of non-RN post-merge dependencies.
Every setup-nix/setup-js call declares the same cache mode. Read cache modes and compiler scopes before changing cache access. Writer credentials belong only to protected push jobs; keep them out of global AWS_* and Nix derivations.
Pin release source SHA before SDK code runs. Release App tokens belong only in isolated permission/tag-push jobs that run no SDK tools. Preserve source branch admission, tag validation, and npm publish's own release environment and branch checks. Read release wiring before editing it.
Pass JS shard flags directly to Just, without an extra --.
Materialize the frozen release plan into Cargo and product metadata before compiling. All six SDKs and any selected CLI must pass validation before any publishes. Publishers use retained checked bytes; iOS publishes its version-keyed archive before its installable tag. Keep React Native's podspec, not standalone CocoaPods.
Keep full Nix build logs off by default. Scope XMTP_NIX_BUILD_LOGS=1 to a debugging dev/nix-shell invocation, or use nix log <drv-path>. Retain failed Compose startup diagnostics from $RUNNER_TEMP/backend-startup-logs.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free