Contributing - hashicorp/faas-nomad GitHub Wiki

First steps please read our contribution guide and code of conduct: https://github.com/hashicorp/faas-nomad/blob/master/CODE_OF_CONDUCT.md
https://github.com/hashicorp/faas-nomad/blob/master/CONTRIBUTING.md

The application including all docker containers are built using goreleaser https://goreleaser.com.

Setup

Clone this repo: go get github.com/hashicorp/faas-nomad Create a fork in your own github account Add a new git remote to $GOPATH/src/hashicorp/faas-nomad with your fork git remote add fork [email protected]:/yourname/faas-nomad.git

Building the application

make build_all this runs the command goreleaser -snapshot -rm-dist -skip-validate

Testing the application

make test runs all unit tests in the application, for continuous test running try http://goconvey.com

When issuing a pull request code quality will be automatically checked by code climate, don't worry if code climate fails your build as nobody is perfect, it is pretty simple to correct the issues and push your branch again. Code climate is in place to ensure the continual code quality of the repository, in leu of being able to pair program, code climate is a pretty decent robot substitute.