From 1247c2264dace02a81bf474a2a7a5eea3be9962a Mon Sep 17 00:00:00 2001
From: Alexander Matyushentsev <Alexander_Matyushentsev@intuit.com>
Date: Mon, 12 Mar 2018 14:41:46 -0700
Subject: [PATCH] Add more details to CONTRIBUTING.md. Describe how to run
 argo-cd locally

---
 CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++------
 1 file changed, 33 insertions(+), 6 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5ddcca88db94d..50415b468771f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,12 +1,39 @@
-
 ## Requirements
+Make sure you have following tools installed [golang](https://golang.org/), [dep](https://github.com/golang/dep), [protobuf](https://developers.google.com/protocol-buffers/),
+[kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
+
 ```
-brew install go dep protobuf
+$  brew install go dep protobuf kubectl
+```
+
+Nice to have [gometaliter](https://github.com/alecthomas/gometalinter) and [goreman](https://github.com/mattn/goreman):
+
+```
+$ go get -u gopkg.in/alecthomas/gometalinter.v2 github.com/mattn/goreman && gometalinter.v2 --install
 ```
 
 ## Building
+
+```
+$ go get -u github.com/argoproj/argo-cd
+$ dep ensure
+$ make
+```
+
+## Running locally
+
+You need to have access to kubernetes cluster (including [minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) or [docker edge](https://docs.docker.com/docker-for-mac/install/) ) in order to run Argo CD on your laptop:
+
+* install kubectl: `brew install kubectl`
+* make sure `kubectl` is connected to your cluster (e.g. `kubectl get pods` should work).
+* install application CRD using following command:
+
+```
+$ kubectl create -f install/manifests/01_application-crd.yaml
+```
+
+* start Argo CD services using [goreman](https://github.com/mattn/goreman):
+
+```
+$ goreman start
 ```
-go get -u github.com/argoproj/argo-cd
-dep ensure
-make
-```
\ No newline at end of file