Contributing to the Tulip Exchange API

Tools

In order to build the project install the dependencies mentioned in the README.

Run a full project build with the command:

$ bazelisk build //...

The examples can be run with the command:

$ bazelisk run //examples/<lang>/<example>

e.g.

$ bazelisk run //examples/node/hello_exchange

In case proto definitions change, are added or removed run Gazelle to regenerate the BUILD files.

$ bazelisk run //:gazelle

We use a couple of linters to format code, be sure to run them before submitting a change.

Clang-format for proto files (bazelisk run //:clang_format)
gofmt for Golang files (bazelisk run //:gofmt_format)
Ktlint for Kotlin files (bazelisk run //:ktlint_format)
IntelliJ IDEA (run headless) for many types of files (bazelisk run //:intellij_format)
addlicense for license headers many types of files (bazelisk run //:addlicense_format)
Buildifier for .bzl, BUILD.bazel and WORKSPACE files (bazelisk run //:buildifier_format)