Contributing

Set up the monorepo, run the checks, and get a pull request merged.

1 min readSynced from mainUpdated Sep 15, 2026

Thanks for helping improve AgentTx. Bug reports, docs fixes, new error rules and new tools are all welcome.

Setup

Terminal

git clone https://github.com/harshal050/agent-tx-protocol.git
cd agent-tx-protocol
pnpm install

You need the prerequisites from Installation: Rust 1.88+, a C++ toolchain, libclang, Node.js 22.12+ and pnpm.

Command	What it does
`pnpm dev`	docs site with hot reload (reads `docs/` locally)
`pnpm test`	Rust tests and TypeScript tests
`pnpm lint`	clippy, rustfmt check, ESLint
`pnpm typecheck`	TypeScript across all packages
`pnpm build`	production build of the site
`pnpm bench:quick`	quick benchmark run
`cargo test -p agenttx-protocol`	Rust tests only

Open an issue first for large changes, so we can agree on the approach.
Keep each PR focused on one change.
Add tests: unit tests next to the code, scenario tests in crates/agenttx-protocol/tests/.
Update docs/ when behavior changes. The site reads these files from main.
Make sure pnpm lint, pnpm typecheck and pnpm test pass.
Use Conventional Commits: feat(engine): …, fix(parser): …, docs: ….

Error rules: add a Rule for an error format you've seen in the wild, with a test case.
Client examples: Go, Java or C# examples in docs/client-integration.md.
Benchmarks: new failure scenarios in crates/agenttx-bench/src/sim.rs.

Run the full suite on a quiet machine and commit the updated benchmarks/results/latest.json. Mention the hardware in the PR description.

This project follows the Contributor Covenant. Be kind.