Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

75 lines (47 loc) · 1.71 KB

Develop

This doc is for contributors to Temporal CLI (hopefully that's you!)

Prerequisites

Build prerequisites

  • Go Lang (minimum version required is 1.19):
    • Install on macOS with brew install go.
    • Install on Ubuntu with sudo apt install golang.

Check out the code

Temporal CLI uses go modules, there is no dependency on $GOPATH variable. Clone the repo into the preferred location:

git clone https://github.com/temporalio/cli.git

Build

Build the temporal binary:

go build ./cmd/temporal

Run tests

Run all tests:

go test ./...

Run Temporal CLI locally

By default the server runs in in-memory mode:

go run ./cmd/temporal server start-dev

Pass --db-filename to persist the state in an SQLite DB

Now you can create default namespace:

temporal namespace register default

and run samples from Go and Java samples repos.

When you are done, press Ctrl+C to stop the server.

License headers

This project is Open Source Software, and requires a header at the beginning of all source files. To verify that all files contain the header execute:

go run ./cmd/copyright

Third party code

The license, origin, and copyright of all third party code is tracked in LICENSE-3rdparty.csv. To verify that this file is up to date execute:

go run ./cmd/licensecheck