Semaphore/CONTRIBUTING.md

27 lines
701 B
Markdown
Raw Normal View History

2016-04-29 15:58:17 +02:00
# Pull Requests
When creating a pull-request you should:
- __Open an issue first:__ Confirm that the change or feature will be accepted
- __gofmt and vet the code:__ Use `gofmt`, `golint`, `govet` and `goimports` to clean up your code.
- __Update api documentation:__ If your pull-request adding/modifying an API request, make sure you update the swagger documentation (`swagger.yml`)
# Installing dependencies
2016-05-17 21:32:37 +02:00
> note: You should clone semaphore with all submodules
2016-04-29 15:58:17 +02:00
```
2016-04-30 09:52:33 +02:00
go get github.com/jteeuwen/go-bindata/...
2016-04-29 15:58:17 +02:00
go get github.com/mitchellh/gox
2016-04-30 09:52:33 +02:00
go get github.com/cespare/reflex
go get -u ./...
npm i -g nodemon less jade
2016-04-29 15:58:17 +02:00
```
# Running in development
```
2016-04-30 09:52:33 +02:00
$EDITOR config.json
2016-04-29 15:58:17 +02:00
./make.sh watch
```