1
0
mirror of https://github.com/containrrr/watchtower.git synced 2024-12-03 08:45:43 +02:00

Update CONTRIBUTING.md

This commit is contained in:
Simon Aronsson 2019-04-14 18:24:54 +02:00 committed by GitHub
parent 1f9099770b
commit 326223de0d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,14 +1,19 @@
## Prerequisites
To contribute code changes to this project you will need the following development kits.
* Go. [Download and install](https://golang.org/doc/install) the Go programming language
* [docker](https://docs.docker.com/engine/installation/)
* [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
When cloning watchtower to your development environment you should place your forked repo within the [standard go code structure](https://golang.org/doc/code.html#Organization).
Do not place your code in the go source path.
```bash
cd $GOPATH/src
mkdir <yourfork>
cd <yourfork>
git clone git@github.com:<yourfork>/watchtower.git
cd watchtower
```
@ -16,9 +21,7 @@ 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 get -u github.com/Masterminds/glide # installs glide for vendoring
glide install # retrieves package dependencies
go build # compiles and packages an executable binary, watchtower
go test # runs tests
go test ./... -v # runs tests with verbose output
./watchtower # runs the application (outside of a container)
```