Skip to content
This repository was archived by the owner on Nov 7, 2022. It is now read-only.

Commit e871853

Browse files
author
Paulo Janotti
authored
List required tools to build from sources (#476)
* List required tools to build from sources Adds the list of required tools to build from sources and so other minor changes to CONTRIBUTING.md * Add note about build requiring $GOPATH/bin on $PATH
1 parent 62b0ae5 commit e871853

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,17 @@ information on using pull requests.
2323

2424
[GitHub Help]: https://help.github.com/articles/about-pull-requests/
2525

26-
## Instructions
26+
## Required Tools
27+
28+
Working with the project sources requires the following tools:
29+
30+
1. [git](https://git-scm.com/)
31+
2. [bzr](http://bazaar.canonical.com/en/)
32+
3. [go](https://golang.org/) (version 1.11.4 and up)
33+
4. [make](https://www.gnu.org/software/make/)
34+
5. [docker](https://www.docker.com/)
35+
36+
## Repository Setup
2737

2838
Fork the repo, checkout the upstream repo to your GOPATH by:
2939

@@ -33,24 +43,29 @@ $ GO111MODULE="" go get -d github.com/census-instrumentation/opencensus-service
3343

3444
Add your fork as an origin:
3545

36-
```
37-
cd $(go env GOPATH)/src/github.com/census-instrumentation/opencensus-service
38-
git remote add fork git@github.com:YOUR_GITHUB_USERNAME/opencensus-service.git
46+
```shell
47+
$ cd $(go env GOPATH)/src/github.com/census-instrumentation/opencensus-service
48+
$ git remote add fork git@github.com:YOUR_GITHUB_USERNAME/opencensus-service.git
3949
```
4050

4151
Run tests, fmt and lint:
4252

43-
```
53+
```shell
4454
$ make install-tools # Only first time.
4555
$ make
4656
```
4757

48-
Checkout a new branch, make modifications and push the branch to your fork
58+
*Note:* the default build target requires tools that are installed at `$(go env GOPATH)/bin`, ensure that `$(go env GOPATH)/bin` is included in your `PATH`.
59+
60+
## Creating a PR
61+
62+
Checkout a new branch, make modifications, build locally, and push the branch to your fork
4963
to open a new PR:
5064

51-
```
65+
```shell
5266
$ git checkout -b feature
5367
# edit
68+
$ make
5469
$ git commit
5570
$ git push fork feature
5671
```

0 commit comments

Comments
 (0)