Skip to content

Latest commit

 

History

History
22 lines (19 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

22 lines (19 loc) · 1.43 KB
Raw

Development, Testing and Contributing

  1. Make sure you have a running Docker daemon (Install for MacOS)
  2. Use a version of Go that supports modules (e.g. Go 1.11+)
  3. Fork this repo and git clone somewhere to $GOPATH/src/github.com/golang-migrate/migrate
    • Ensure that Go modules are enabled (e.g. your repo path or the GO111MODULE environment variable are set correctly)
  4. Confirm tests are working: make test-short
  5. Write awesome code ...
  6. make test to run all tests against all database versions
  7. Push code and open Pull Request

Some more helpful commands:

  • You can specify which database/ source tests to run: make test-short SOURCE='file go_bindata' DATABASE='postgres cassandra'
  • After make test, run make html-coverage which opens a shiny test coverage overview.
  • make build-cli builds the CLI in directory cli/build/.
  • make list-external-deps lists all external dependencies for each package
  • make docs && make open-docs opens godoc in your browser, make kill-docs kills the godoc server. Repeatedly call make docs to refresh the server.
  • 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.