Contributing

Setup your machine

optional is written in Go.

Prerequisites are:

Clone optional from source into $GOPATH:

$ go get github.com/markphelps/optional
$ cd $GOPATH/src/github.com/markphelps/optional

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:

$ make build

If you change the public API, you may have to update the goldenfiles in cmd/optional.

To do so, run:

$ go test ./cmd/optional/... -update

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 optional fork and open a pull request against the master branch.