1# Development, Testing and Contributing
2
3 1. Make sure you have a running Docker daemon
4 (Install for [MacOS](https://docs.docker.com/docker-for-mac/))
5 1. Use a version of Go that supports [modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) (e.g. Go 1.11+)
6 1. Fork this repo and `git clone` somewhere to `$GOPATH/src/github.com/golang-migrate/migrate`
7 * Ensure that [Go modules are enabled](https://golang.org/cmd/go/#hdr-Preliminary_module_support) (e.g. your repo path or the `GO111MODULE` environment variable are set correctly)
8 1. Install [golangci-lint](https://github.com/golangci/golangci-lint#install)
9 1. Run the linter: `golangci-lint run`
10 1. Confirm tests are working: `make test-short`
11 1. Write awesome code ...
12 1. `make test` to run all tests against all database versions
13 1. Push code and open Pull Request
14
15Some more helpful commands:
16
17 * You can specify which database/ source tests to run:
18 `make test-short SOURCE='file go_bindata' DATABASE='postgres cassandra'`
19 * After `make test`, run `make html-coverage` which opens a shiny test coverage overview.
20 * `make build-cli` builds the CLI in directory `cli/build/`.
21 * `make list-external-deps` lists all external dependencies for each package
22 * `make docs && make open-docs` opens godoc in your browser, `make kill-docs` kills the godoc server.
23 Repeatedly call `make docs` to refresh the server.
24 * Set the `DOCKER_API_VERSION` environment variable to the latest supported version if you get errors regarding the docker client API version being too new.
View as plain text