watchtower/CONTRIBUTING.md

28 lines
998 B
Markdown
Raw Normal View History

## Prerequisites
To contribute code changes to this project you will need the following development kits.
2019-04-14 18:24:54 +02:00
* [Go](https://golang.org/doc/install)
* [Docker](https://docs.docker.com/engine/installation/)
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:
```bash
~ $ go version
go version go1.12.1 darwin/amd64
```
## Checking out the code
2019-04-14 18:24:54 +02:00
Do not place your code in the go source path.
```bash
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.
```bash
go build # compiles and packages an executable binary, watchtower
2019-04-14 18:24:54 +02:00
go test ./... -v # runs tests with verbose output
./watchtower # runs the application (outside of a container)
```