Skip to content

Commit d8593a9

Browse files
committed
Copy edit CONTRIBUTING
Signed-off-by: Dave Cheney <[email protected]>
1 parent 6597628 commit d8593a9

File tree

1 file changed

+4
-9
lines changed

1 file changed

+4
-9
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,10 @@ This section describes how to build Contour from source.
1717

1818
### Fetch the source
1919

20-
Contour uses [`go modules`][2] for dependency management, but to reduce the size of the repository, does not include a copy of its dependencies.
20+
Contour uses [`go modules`][2] for dependency management.
2121

2222
```
23-
go get -d github.com/heptio/contour
24-
cd $GOPATH/src/github.com/heptio/contour
25-
go mod vendor
23+
go github.com/heptio/contour
2624
```
2725

2826
Go is very particular when it comes to the location of the source code in your `$GOPATH`.
@@ -43,10 +41,9 @@ The remainder of this document assumes your terminal's working directory is `$GO
4341
To build Contour, run:
4442

4543
```
46-
go build -mod=vendor ./cmd/contour
44+
make
4745
```
4846

49-
This assumes your working directory is set to `$GOPATH/src/github.com/heptio/contour`.
5047
This produces a `contour` binary in your current working directory.
5148

5249
_TIP_: You may prefer to use `go install` rather than `go build` to cache build artifacts and reduce future compile times.
@@ -57,7 +54,7 @@ In this case the binary is placed in `$GOPATH/bin/contour`.
5754
Once you have Contour building, you can run all the unit tests for the project:
5855

5956
```
60-
go test -mod=vendor ./...
57+
make check
6158
```
6259

6360
This assumes your working directory is set to `$GOPATH/src/github.com/heptio/contour`.
@@ -68,8 +65,6 @@ To run the tests for a single package, change to package directory and run:
6865
go test .
6966
```
7067

71-
_TIP_: If you are running the tests often, you can run `go test -i github.com/heptio/contour/...` occasionally to reduce test compilation times.
72-
7368
## Contribution workflow
7469

7570
This section describes the process for contributing a bug fix or new feature.

0 commit comments

Comments
 (0)