Something went wrong. Try again.
My version of https://github.com/vercel-labs/fx
Something went wrong. Try again.
fx CONTRIBUTING.md
# Contributing
## Scope
`fx` is a CLI-first coding agent written in Zig.
Contributions should preserve that direction:
* CLI-first over terminal-IDE behavior
* explicit contracts over ad hoc strings and branches
* permission-first security model
* small, reviewable changes
* honest docs and status reporting
## Setup
Requirements:
* Zig `0.16.0+`
* interactive terminal for manual shell testing
* a Vercel OAuth session via `fx login` for model-backed flows. macOS Keychain API keys (via `fx setup`), `AI_GATEWAY_API_KEY`, and `VERCEL_OIDC_TOKEN` are also supported
Common commands:
```bash
zig fmt src/
zig build
zig build test
zig build run
```
## Verification Workflow
Keep the local development loop focused: run the narrowest test that covers the changed path, build fx, and exercise the change using `./zig-out/bin/fx`. The installed `fx` on `PATH` is not valid development evidence.
Once the focused checks pass, create a clean checkpoint commit, push the non-`main` feature branch, and open a draft PR immediately. The **Full CI** workflow runs the complete deterministic suite on native Linux x86_64, Linux aarch64, macOS x86_64, and macOS aarch64 runners. The native matrix builds, tests, and smoke-tests ReleaseSafe on every platform; formatting and the public-surface audit run in those ReleaseSafe jobs. Four duration-balanced, isolated ReleaseSafe E2E shards per platform use checked-in weights to assign every Bun test file once; files inside each shard run sequentially in separate Bun processes so terminal fixtures and process state cannot leak between files. A failed file receives one bounded retry after tmux is reset.
Standard PR CI reports ReleaseSafe Build & Test and deterministic E2E results. Do not mark the draft PR ready until all four Full CI jobs and the final ship gate have succeeded for the exact current commit. Each platform aggregate requires its ReleaseSafe native check and all four ReleaseSafe E2E shards. A result from an older commit does not count. Live model evals are separate from t…