Skip to content

Commit

Permalink
update contributing guide with clear test deps
Browse files Browse the repository at this point in the history
  • Loading branch information
issmirnov committed Dec 1, 2018
1 parent 0bf8aef commit b92c781
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -3,7 +3,20 @@
Patches are welcome! Please use the standard GitHub workflow - fork this
repo and submit a PR. I'll usually get to it within a few days.

Handy commands for local development:
## Setting up dev environment

- Install [Goland](https://www.jetbrains.com/go/), [Atom](https://atom.io/),
or your favorite web editor with Golang support.

```
cd $GOPATH/src/github.com/issmirnov/zap
go build . # sanity check
# install test deps
go get github.com/smartystreets/goconvey
```

## Handy commands for local development:

- `go run main.go config.go text.go web.go` to run locally
- `curl -I -L -H 'Host: g' localhost:8927/z` - to test locally e2e
Expand Down

0 comments on commit b92c781

Please sign in to comment.