migrate/CONTRIBUTING.md

# Development, Testing and Contributing

  1. Make sure you have a running Docker daemon
     (Install for [MacOS](https://docs.docker.com/docker-for-mac/))
  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+)
  1. Fork this repo and `git clone` somewhere to `$GOPATH/src/github.com/golang-migrate/migrate`
      * 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)
  1. Confirm tests are working: `make test-short`
  1. Write awesome code ...
  1. `make test` to run all tests against all database versions
  1. 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.
move contributing in own file 2017-02-10 04:03:56 +00:00			`# Development, Testing and Contributing`

			`1. Make sure you have a running Docker daemon`
			`(Install for [MacOS](https://docs.docker.com/docker-for-mac/))`
Remove references to `dep` from docs 2018-10-29 17:55:22 +00:00			`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+)`
Update docs regarding usage of dep 2018-05-13 07:24:15 +00:00			1. Fork this repo and `git clone` somewhere to `$GOPATH/src/github.com/golang-migrate/migrate`
Remove references to `dep` from docs 2018-10-29 17:55:22 +00:00			* 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)
Update docs regarding usage of dep 2018-05-13 07:24:15 +00:00			1. Confirm tests are working: `make test-short`
			`1. Write awesome code ...`
			1. `make test` to run all tests against all database versions
			`1. Push code and open Pull Request`
move contributing in own file 2017-02-10 04:03:56 +00:00
Update documentation 2017-02-11 19:13:27 +00:00			`Some more helpful commands:`
move contributing in own file 2017-02-10 04:03:56 +00:00
Add tip about dealing with docker client API version issues 2018-01-19 22:31:56 +00:00			`* You can specify which database/ source tests to run:`
Rename sources to reflect updated build constraint names 2018-06-12 08:32:58 +00:00			`make test-short SOURCE='file go_bindata' DATABASE='postgres cassandra'`
Add tip about dealing with docker client API version issues 2018-01-19 22:31:56 +00:00			* After `make test`, run `make html-coverage` which opens a shiny test coverage overview.
move contributing in own file 2017-02-10 04:03:56 +00:00			* `make build-cli` builds the CLI in directory `cli/build/`.
			* `make list-external-deps` lists all external dependencies for each package
Add tip about dealing with docker client API version issues 2018-01-19 22:31:56 +00:00			* `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.