Skip to content

Commit 5b2209c

Browse files
author
Shlomi Noach
authored
Merge branch 'master' into critical-load-hibernate
2 parents 8da0f60 + 5585c25 commit 5b2209c

3 files changed

Lines changed: 22 additions & 3 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,4 @@ This PR [briefly explain what is does]
1616
> In case this PR introduced Go code changes:
1717
1818
- [ ] contributed code is using same conventions as original code
19-
- [ ] code is formatted via `gofmt` (please avoid `goimports`)
20-
- [ ] code is built via `./build.sh`
21-
- [ ] code is tested via `./test.sh`
19+
- [ ] `script/cibuild` returns with no formatting errors, build errors or unit test errors.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,8 @@ But then a rare genetic mutation happened, and the `c` transformed into `t`. And
8484

8585
We develop `gh-ost` at GitHub and for the community. We may have different priorities than others. From time to time we may suggest a contribution that is not on our immediate roadmap but which may appeal to others.
8686

87+
Please see [Coding gh-ost](https://github.com/github/gh-ost/blob/develdocs/doc/coding-ghost.md) for a guide to getting started developing with gh-ost.
88+
8789
## Download/binaries/source
8890

8991
`gh-ost` is now GA and stable.

doc/coding-ghost.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Getting started with gh-ost development.
2+
3+
## Overview
4+
5+
Getting started with gh-ost development is simple!
6+
7+
- First obtain the repository with `git clone` or `go get`.
8+
- From inside of the repository run `script/cibuild`
9+
- This will bootstrap the environment if needed, format the code, build the code, and then run the unit test.
10+
11+
## CI build workflow
12+
13+
`script/cibuild` performs the following actions will bootstrap the environment to build `gh-ost` correctly, build, perform syntax checks and run unit tests.
14+
15+
If additional steps are needed, please add them into this workflow so that the workflow remains simple.
16+
17+
## Notes:
18+
19+
Currently, `script/ensure-go-installed` will install `go` for Mac OS X and Linux. We welcome PR's to add other platforms.

0 commit comments

Comments
 (0)