Permalink
Browse files

Update CONTRIBUTING to reflect Go Dep

Closes #3988
  • Loading branch information...
bep committed Oct 21, 2017
1 parent f711b17 commit 30e471b8c66f43b2505ba4a303b5cacb4a5f3af3
Showing with 11 additions and 11 deletions.
  1. +11 −11 CONTRIBUTING.md
View
@@ -90,29 +90,29 @@ Fixes #1949
### Vendored Dependencies
Hugo uses [govendor](https://github.com/kardianos/govendor) to vendor dependencies, but we don't commit the vendored packages themselves to the Hugo git repository.
Hugo uses [Go Dep](https://github.com/golang/dep) to vendor dependencies, but we don't commit the vendored packages themselves to the Hugo git repository.
Therefore, a simple `go get` is not supported since `go get` is not vendor-aware.
You **must use govendor** to fetch and manage Hugo's dependencies.
### Fetch the Sources From GitHub
You **must use Go Dep** to fetch and manage Hugo's dependencies.
```
go get -u github.com/kardianos/govendor
govendor get github.com/gohugoio/hugo
```
### Using Git Remotes
### Fetch the Sources From GitHub
Due to the way Go handles package imports, the best approach for working on a
Hugo fork is to use Git Remotes. Here's a simple walk-through for getting
started:
1. Fetch the Hugo sources as described above.
1. Install Go Dep and get the Hugo source:
```
go get -u -v github.com/golang/dep/cmd/dep
go get -u -v -d github.com/gohugoio/hugo
```
1. Change to the Hugo source directory:
1. Change to the Hugo source directory and fetch the dependencies:
```
cd $HOME/go/src/github.com/gohugoio/hugo
dep ensure
```
1. Create a new branch for your changes (the branch name is arbitrary):

0 comments on commit 30e471b

Please sign in to comment.