Contributing

By participating to this project, you agree to abide our code of conduct.

Setup your machine

example is written in Go.

Prerequisites are:

Clone example from source into $GOPATH:

$ go get github.com/caarlos0/example
$ cd $GOPATH/src/github.com/caarlos0/example

Install the build and lint dependencies:

$ make setup

A good way of making sure everything is all right is running the test suite:

$ make test

You can create a branch for your changes and try to build from the source as you go:

$ go build

When you are satisfied with the changes, we suggest you run:

$ make ci

Which runs all the linters and tests.

Push your branch to your example fork and open a pull request against the master branch.