Skip to content
This repository has been archived by the owner on Apr 3, 2024. It is now read-only.

Latest commit

 

History

History
59 lines (47 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

59 lines (47 loc) · 1.7 KB
Raw

Develop Temporalite

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

Prerequisites

Build prerequisites

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

Check out the code

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

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

Build

Build the temporalite binary:

go build ./cmd/temporalite

Run tests

Run all tests:

go test ./...

Run Temporalite locally

Run the server in ephemeral mode:

go run ./cmd/temporalite start --ephemeral

Now you can create default namespace with tctl:

tctl --ns default namespace register

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 ./internal/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 ./internal/licensecheck