gh-ost/doc/coding-ghost.md

# Getting started with gh-ost development.

## Overview

Getting started with gh-ost development is simple!

- First clone the repository.
- From inside of the repository run `script/cibuild`
- This will bootstrap the environment if needed, format the code, build the code, and then run the unit test.

## CI build workflow

`script/cibuild` performs the following actions:

- It runs `script/bootstrap`
- `script/bootstrap` runs `script/ensure-go-installed`
- `script/ensure-go-installed` installs go locally if (go is not installed) || (go is not version 1.7). It will not install go if it is already installed locally and at the correct version.
- `script/build` builds the `gh-ost` binary and places in in `bin/`

## Notes:

Currently, `script/ensure-go-installed` will install `go` for Mac OS X and Linux. We welcome PR's to add other platforms.
- Initial documentation on contributing to gh-ost. - It is a bit sparse currently, but will give beginners an idea how on to setup the environment and run tests. - A good starting point for further PR's. 2017-05-03 20:25:31 +00:00			`# Getting started with gh-ost development.`

			`## Overview`

			`Getting started with gh-ost development is simple!`

			`- First clone the repository.`
			- From inside of the repository run `script/cibuild`
			`- This will bootstrap the environment if needed, format the code, build the code, and then run the unit test.`

			`## CI build workflow`

			`script/cibuild` performs the following actions:

			- It runs `script/bootstrap`
- Initial documentation on getting started developing for gh-ost. 2017-05-03 20:31:45 +00:00			- `script/bootstrap` runs `script/ensure-go-installed`
			- `script/ensure-go-installed` installs go locally if (go is not installed) \|\| (go is not version 1.7). It will not install go if it is already installed locally and at the correct version.
			- `script/build` builds the `gh-ost` binary and places in in `bin/`
- Initial documentation on contributing to gh-ost. - It is a bit sparse currently, but will give beginners an idea how on to setup the environment and run tests. - A good starting point for further PR's. 2017-05-03 20:25:31 +00:00
			`## Notes:`

			Currently, `script/ensure-go-installed` will install `go` for Mac OS X and Linux. We welcome PR's to add other platforms.