You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
watchtower/CONTRIBUTING.md

1.2 KiB

Prerequisites

To contribute code changes to this project you will need the following development kits.

As watchtower utilizes go modules for vendor locking, you'll need atleast Go 1.11. You can check your current version of the go language as follows:

  ~ $ go version
  go version go1.12.1 darwin/amd64

Checking out the code

Do not place your code in the go source path.

git clone git@github.com:<yourfork>/watchtower.git
cd watchtower

Building and testing

watchtower is a go application and is built with go commands. The following commands assume that you are at the root level of your repo.

go build                               # compiles and packages an executable binary, watchtower
go test ./... -v                       # runs tests with verbose output
./watchtower                           # runs the application (outside of a container)

If you dont have it enabled, you'll either have to prefix each command with GO111MODULE=on or run export GO111MODULE=on before running the commands. You can read more about modules here.