From 3783016c66fcc7f47f9253969af55df54c7f3831 Mon Sep 17 00:00:00 2001 From: Chanwit Kaewkasi Date: Fri, 13 Feb 2015 21:26:20 +0700 Subject: [PATCH] clarify dev workflow Signed-off-by: Chanwit Kaewkasi --- CONTRIBUTING.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d643ed5f6..ddec967eee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,13 +34,15 @@ Then you can fetch `swarm` code to your `$GOPATH`. go get -d github.com/docker/swarm ``` -The final step is to prepare dependencies for `swarm` and compile it. +#### Start hacking + +First, prepare dependencies for `swarm` and try to compile it. ```sh cd src/github.com/docker/swarm $GOBIN/godep restore +go test go install ``` -You'll find the `swarm` binary under the `$GOBIN` directory. #### Adding New Dependencies @@ -52,4 +54,11 @@ git diff # check what added or removed in Godep/Godeps.json # then manually add missing dependencies ``` +To make sure you newly added codes will make the build process happy, you can try building Swarm in the same way as defined in `Dockerfile`. + +```sh +$GOBIN/godep go install +``` +Then you should find the `swarm` binary under the `$GOBIN` directory. + Happy hacking!