octoleo/gh-ost
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

- Getting started with gh-ost documentation.

Browse Source
This commit is contained in:
Jess Breckenridge 2017-05-02 14:57:26 -06:00
parent 03e8d65938
commit d609d89f78
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/bootstrapping-devel.md Normal file
View File

@ -0,0 +1,12 @@
## Getting started with gh-ost development.
Getting started with gh-ost development is simple!
- First clone the repository.
- From inside the repository directory, run ./script/bootstrap.
- From inside the repository directory, run ./test.sh to run the tests and validate your environment.
A couple of notes here:
- Any scripts you use for development should include `. ./scripts/env.sh` at the top. All environment variables, `$GOPATH`, `$GOROOT`, etc are set here so that all scripts can use them.
- `$GOCMD` is set to use `go 1.7` installed inside the repository. This is done so that all development is using the same version of go for easy troubleshooting.