Skip to content

Latest commit

 

History

History
42 lines (32 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

42 lines (32 loc) · 1.76 KB

Contributing to Weir

Focused bug fixes, documentation improvements, tests and feature proposals are welcome. For changes to the public protocol or to batching and write semantics, open an issue first so the server, protocol, Go SDK, Helm chart and system tests can change together.

Report a problem

Use the issue forms and include the output of weir version, the backend and its version, the SDK version, the expected result and a minimal reproduction. Include relevant logs and configuration with credentials and private data removed. For capacity reports, describe the workload, replica count and resource limits.

For vulnerabilities, follow SECURITY.md.

Work locally

Install the Go version declared in go.mod.

git clone https://github.com/batchstream/weir.git
cd weir
go build -o bin/weir ./cmd/weir
go test ./...
go test -race ./...
go vet ./...
go vet -tags=integration ./...

Default tests need no backends. Integration, load and fault tests use Docker and the local fixtures under scripts/.

Prepare a pull request

  • Keep the change focused and explain the observed problem and resulting behavior.
  • Add a regression test when fixing behavior.
  • Update the documentation and the reference configuration when configuration or APIs change.
  • Change public schemas in weir-protocol, and add blackbox and cross-component tests to weir-tests.