Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

41 lines (26 loc) · 1.13 KB
Raw

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. Install on OS X with brew install go. The minimum required Go version is 1.14.

Checking out the code

Make sure the repository is cloned to the preferred location: (Note: the path is go.temporal.io/sdk instead of github repo)

go get -u go.temporal.io/sdk

Licence 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:

make copyright

Commit Messages

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.

Testing

Run all the tests with coverage and race detector enabled:

make test