Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

*: tiny update CONTRIBUTING.md #8814

Merged
merged 4 commits into from
Jan 14, 2019
Merged

*: tiny update CONTRIBUTING.md #8814

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b025209
*: tiny update CONTRIBUTING.md
tiancaiamao Dec 25, 2018
b8a96f7
address comment
tiancaiamao Dec 26, 2018
40410cf
address comment
tiancaiamao Dec 27, 2018
193c2bc
Merge branch 'master' into update-contributing
zz-jason Jan 14, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,25 @@ please [set one up](http://golang.org/doc/code.html).

The version of GO should be **1.11** or above.

After installation, you'll need `GOPATH` defined,
and `PATH` modified to access your Go binaries.
After installation, there are two ways to build TiDB binary.

#### For a quick taste
zz-jason marked this conversation as resolved.
Show resolved Hide resolved

The `GOPATH` is not necessary.

```
mkdir tmp
zz-jason marked this conversation as resolved.
Show resolved Hide resolved
cd tmp
echo 'module tidb' > go.mod
GO111MODULE=on go get github.com/pingcap/tidb@c385cbdcca83eeed283139814a7ea149e3116e66
GO111MODULE=on go build -o tidb-server github.com/pingcap/tidb/tidb-server
```

The `c385cbdcca83eeed283139814a7ea149e3116e66` can be changed to any other commit hash. Try the latest commit hash [here](https://github.com/pingcap/tidb/commits/master).

#### For development

You'll need `GOPATH` defined, and `PATH` modified to access your Go binaries.

A common setup is the following but you could always google a setup for your own flavor.

Expand Down