Focused fixes, documentation improvements, tests and proposals are welcome. Schema changes reach every client and server, so open an issue first and link the coordinated server and SDK changes.
Use the issue forms and include the protocol version, the server or SDK that consumes it, the expected result and a minimal reproduction. Remove credentials and private data from logs and configuration.
For vulnerabilities, follow SECURITY.md.
Install the Go version declared in go.mod.
git clone https://github.com/batchstream/weir-protocol.git
cd weir-protocol
go test -race ./...
go vet ./...Default tests use in-memory protocol data. To regenerate code, install the
exact tool versions, then run ./scripts/generate.sh and
git diff --exit-code.
- Keep the change focused and explain the observed problem and resulting behavior.
- Add a regression test when fixing behavior.
- Commit generated code from
scripts/generate.shtogether with the.protochange. - Keep the dependency direction one-way: this module depends on neither the server nor the SDK.