gh-ost/doc/coding-ghost.md

# Getting started with gh-ost development.

## Overview

Getting started with gh-ost development is simple!

- First obtain the repository with `git clone` or `go get`.
- 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 will bootstrap the environment to build `gh-ost` correctly, build, perform syntax checks and run unit tests.

If additional steps are needed, please add them into this workflow so that the workflow remains simple.

## `golang-ci` linter

To enfore best-practices, Pull Requests are automatically linted by [`golang-ci`](https://golangci-lint.run/). The linter config is located at [`.golangci.yml`](https://github.com/github/gh-ost/blob/master/.golangci.yml) and the `golangci-lint` GitHub Action is located at [`.github/workflows/golangci-lint.yml`](https://github.com/github/gh-ost/blob/master/.github/workflows/golangci-lint.yml).

To run the `golang-ci` linters locally _(recommended before push)_, use `script/lint`.

## 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!`

- Updating PR template to reflect current build workflow 2017-05-04 18:51:00 +00:00			- First obtain the repository with `git clone` or `go get`.
Add script and docs for linter (#1151) 2022-07-18 16:21:32 +00:00			- From inside of the repository run `script/cibuild`.
- 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			`- This will bootstrap the environment if needed, format the code, build the code, and then run the unit test.`

			`## CI build workflow`

- Updating PR template to reflect current build workflow 2017-05-04 18:51:00 +00:00			`script/cibuild` performs the following actions will bootstrap the environment to build `gh-ost` correctly, build, perform syntax checks and run unit tests.
- 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
- Updating PR template to reflect current build workflow 2017-05-04 18:51:00 +00:00			`If additional steps are needed, please add them into this workflow so that the workflow remains simple.`
- 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
Add script and docs for linter (#1151) 2022-07-18 16:21:32 +00:00			## `golang-ci` linter

			To enfore best-practices, Pull Requests are automatically linted by [`golang-ci`](https://golangci-lint.run/). The linter config is located at [`.golangci.yml`](https://github.com/github/gh-ost/blob/master/.golangci.yml) and the `golangci-lint` GitHub Action is located at [`.github/workflows/golangci-lint.yml`](https://github.com/github/gh-ost/blob/master/.github/workflows/golangci-lint.yml).

			To run the `golang-ci` linters locally _(recommended before push)_, use `script/lint`.

- 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.