CONTRIBUTING.md

Developing Temporal Go SDK

This doc is intended for contributors to Go SDK (hopefully that's you!)

Note: All contributors also need to fill out the Temporal Contributor License Agreement before we can merge in any of your changes.

Development Environment

• Go Lang (minimum version required is 1.14):

  • Ubuntu: sudo apt install golang.

  • OS X: brew install go and add this to your .bashrc:

    ```
    export GOPATH=$HOME/go
    export GOROOT="$(brew --prefix go)/libexec"
    export PATH="$PATH:${GOPATH}/bin:${GOROOT}/bin"
    ```
    

Checking out the code

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

git clone https://github.com/temporalio/sdk-go.git

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/cmd/tools/copyright/licensegen.go

Commit Messages And Titles of Pull Requests

Overcommit adds some requirements to your commit messages. At Temporal, we follow the Chris Beams guide to writing git commit messages. Read it, follow it, learn it, love it.

All commit messages are from the titles of your pull requests. So make sure follow the rules when titling them. Please don't use very generic titles like "bug fixes".

All PR titles should start with Upper case.

Testing

Run all static analysis tools:

cd ./internal/cmd/build
go run . check

Run the integration tests (requires local server running, or pass -dev-server):

cd ./internal/cmd/build
go run . integration-test

Run the unit tests:

cd ./internal/cmd/build
go run . unit-test

Updating go mod files

Sometimes all go.mod files need to be tidied. For an easy way to do this on linux or (probably) mac, run:

find . -name go.mod -execdir go mod tidy \;