diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 000000000..ee0da6053 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,16 @@ +# AGENTS instructions + +## Formatting + +- Run `gofmt -w` and `gofumpt -w` on any modified Go files. +- Run `cargo fmt` on any modified Rust files. +- Run `prettier -w` on any modified Markdown files. + +## Testing + +- Use `golangci-lint run ./... --fix` before running `make test` and make sure that all lint issues are fixed before running tests. +- When Go or Rust code is changed, run `make test` before committing. + +## PR message + +- Summarize the changes and mention any test commands that were executed.