From 64bad3f2183ee74cb8af2f0d4aae9afa3feeefcb Mon Sep 17 00:00:00 2001 From: Yuce Tekol Date: Thu, 3 Nov 2016 16:37:45 +0300 Subject: [PATCH 1/4] added dev docs --- README-dev.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 README-dev.md diff --git a/README-dev.md b/README-dev.md new file mode 100644 index 000000000..0f8871a74 --- /dev/null +++ b/README-dev.md @@ -0,0 +1,77 @@ + +Development Environment +======================= + +Install Go versions 1.6.2+ or 1.7 for your platform. + +Fork `github.com/umbel/pilosa` to your own account. The forked repo will be private. + +In a shell, export your work directory as `$GOPATH`: + +```sh +export GOPATH=$HOME/Work/pilosa/server +``` + +Update `$PATH` to get access to Pilosa command line tools: + +```sh +export PATH=$PILOSA_HOME/bin:$PATH +``` + +Create a directory (note that we use `github.com/umbel`, NOT `github.com/USER`) and clone your own Pilosa repo: + +```sh +mkdir -p ${GOPATH}/src/github.com/umbel && cd $_ +git clone git@github.com:${USER}/pilosa.git +``` + +`cd` to your pilosa directory: + +```sh +cd ${GOPATH}/src/github.com/umbel/pilosa +``` + +Install `godep` to manage dependencies: + +```sh +go get -u github.com/tools/godep +``` + +Install Pilosa command line tools: + +```sh +go install github.com/umbel/pilosa/... +``` + +Running `pilosa` should now run a Pilosa instance. + +In order to sync your fork with upstream Umbel repo, add an *upstream* to your repo: + +```sh +cd ${GOPATH}/src/github.com/umbel/pilosa +git remote add upstream git@github.com:umbel/pilosa.git +``` + +Before starting to work on a task, sync your branch with the upstream: + +```sh +git fetch upstream +git checkout master +git merge upstream/master +``` + +Create a branch for the task: + +```sh +git checkout -b a-branch-for-the-task +``` + +Update the code in the branch, and commit it. + +Push it to your own repo: + +```sh +git push --set-upstream origin a-branch-for-the-task +``` + +All left to do is creating a pull request on github.com. From 9e3bfe9d5cc67943ba191942e23f6f8942ba6664 Mon Sep 17 00:00:00 2001 From: Yuce Tekol Date: Thu, 3 Nov 2016 16:45:52 +0300 Subject: [PATCH 2/4] typo --- README-dev.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README-dev.md b/README-dev.md index 0f8871a74..b42356ff6 100644 --- a/README-dev.md +++ b/README-dev.md @@ -15,7 +15,7 @@ export GOPATH=$HOME/Work/pilosa/server Update `$PATH` to get access to Pilosa command line tools: ```sh -export PATH=$PILOSA_HOME/bin:$PATH +export PATH=GOPATH/bin:$PATH ``` Create a directory (note that we use `github.com/umbel`, NOT `github.com/USER`) and clone your own Pilosa repo: From ef3f40bc9c21c7ab1157f331441ed64aec153e28 Mon Sep 17 00:00:00 2001 From: Yuce Tekol Date: Thu, 3 Nov 2016 16:47:17 +0300 Subject: [PATCH 3/4] typo --- README-dev.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README-dev.md b/README-dev.md index b42356ff6..9b8e9b06a 100644 --- a/README-dev.md +++ b/README-dev.md @@ -15,7 +15,7 @@ export GOPATH=$HOME/Work/pilosa/server Update `$PATH` to get access to Pilosa command line tools: ```sh -export PATH=GOPATH/bin:$PATH +export PATH=$GOPATH/bin:$PATH ``` Create a directory (note that we use `github.com/umbel`, NOT `github.com/USER`) and clone your own Pilosa repo: From 59dde04b6dcdb12e1f98082e7e16cdb95343b319 Mon Sep 17 00:00:00 2001 From: Yuce Tekol Date: Thu, 3 Nov 2016 16:55:01 +0300 Subject: [PATCH 4/4] Removed export /home/yuce/Work/pilosa/server lines --- README-dev.md | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/README-dev.md b/README-dev.md index 9b8e9b06a..ed782db59 100644 --- a/README-dev.md +++ b/README-dev.md @@ -6,17 +6,7 @@ Install Go versions 1.6.2+ or 1.7 for your platform. Fork `github.com/umbel/pilosa` to your own account. The forked repo will be private. -In a shell, export your work directory as `$GOPATH`: - -```sh -export GOPATH=$HOME/Work/pilosa/server -``` - -Update `$PATH` to get access to Pilosa command line tools: - -```sh -export PATH=$GOPATH/bin:$PATH -``` +Make sure `$GOPATH` environment variable points to your Go working directory and `$PATH` incudes `$GOPATH/bin`. Create a directory (note that we use `github.com/umbel`, NOT `github.com/USER`) and clone your own Pilosa repo: