Skip to content

Commit

Permalink
A few small cleanups to CONTRIBUTING.md (influxdata#855)
Browse files Browse the repository at this point in the history
  • Loading branch information
toddboom authored and Nathaniel Cook committed Aug 31, 2016
1 parent a633b84 commit 4fe566a
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,19 +80,19 @@ Getting the source
------
Setup the project structure and fetch the repo like so:

mkdir $HOME/gocodez
export GOPATH=$HOME/gocodez
mkdir $HOME/go
export GOPATH=$HOME/go
go get github.com/influxdata/kapacitor

You can add the line `export GOPATH=$HOME/gocodez` to your bash/zsh file to be set for every shell instead of having to manually run it everytime.
You can add the line `export GOPATH=$HOME/go` to your bash/zsh file to be set for every shell instead of having to manually run it everytime.

Cloning a fork
-------------
If you wish to work with fork of Kapacitor, your own fork for example, you must still follow the directory structure above.
But instead of cloning the main repo, instead clone your fork. Follow the steps below to work with a fork:

export GOPATH=$HOME/gocodez
mkdir -p $GOPATH/src/github.com/influxdb
export GOPATH=$HOME/go
mkdir -p $GOPATH/src/github.com/influxdata
cd $GOPATH/src/github.com/influxdata
git clone [email protected]:<username>/kapacitor

Expand Down Expand Up @@ -124,8 +124,7 @@ Build and Test
Make sure you have Go installed and the project structure as shown above. To then build the project, execute the following commands:

```bash
cd $GOPATH/src/github.com/influxdb/kapacitor
go get ./...
cd $GOPATH/src/github.com/influxdata/kapacitor
go build ./cmd/kapacitor
go build ./cmd/kapacitord
```
Expand All @@ -134,8 +133,7 @@ Kapacitor builds two binares is named `kapacitor`, and `kapacitord`.
To run the tests, execute the following command:

```bash
go get -t ./...
go test ./...
go test $(go list ./... | grep -v /vendor/)
```

Dependencies
Expand Down

0 comments on commit 4fe566a

Please sign in to comment.