Semaphore/CONTRIBUTING.md

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

Clone the project to $GOPATH/src/github.com/ansible-semaphore/semaphore (more on GOPATHS below)

note: You should clone semaphore with all submodules

• you should have latest go installed and node with ES6 (used to be a special harmony flag) capability

go get github.com/jteeuwen/go-bindata/...
go get github.com/mitchellh/gox
go get github.com/cespare/reflex
go get -u ./...

npm i -g nodemon less jade
npm i async

Gopaths

To develop in Go, you need to setup a gopath where go code, libraries & executables live.

Follow either of these (go wiki, tutorial, SO question).

1. mkdir -p $GOPATH/src/github.com/ansible-semaphore
2. cd $GOPATH/src/github.com/ansible-semaphore
3. git clone --recursive git@github.com:ansible-semaphore/semaphore.git
4. Now install dependencies above

Running in development

You will need to have a local config.json file because it is linked to. It should contain your local configuration.

$EDITOR config.json
./make.sh watch