Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bep committed Aug 29, 2018
1 parent f627903 commit 312d225
Showing 1 changed file with 13 additions and 20 deletions.
33 changes: 13 additions & 20 deletions CONTRIBUTING.md
Expand Up @@ -106,30 +106,23 @@ Fixes #1949

### Fetching 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:
Since Hugo 0.48, Hugo uses the Go Modules support built into Go 1.11 to build. The easiest is is to clone Hugo in a directory outside of `GOPATH`, as in the following example:

1. Get the Hugo source:

```bash
go get -u -v -d github.com/gohugoio/hugo
```

1. Install Mage:

```bash
go get github.com/magefile/mage
```
```bash
mkdir $HOME/src
cd $HOME/src
git clone https://github.com/gohugoio/hugo.git
cd hugo
go install
```

1. Change to the Hugo source directory and fetch the dependencies:
For some convenient build and test targets, you also will want to install Mage:

```bash
cd $HOME/go/src/github.com/gohugoio/hugo
mage vendor
```
```bash
go get github.com/magefile/mage
```

Note that Hugo uses [Go Dep](https://github.com/golang/dep) to vendor dependencies, rather than a simple `go get`. We don't commit the vendored packages themselves to the Hugo git repository. The call to `mage vendor` takes care of all this for you.
Now, to make a change to Hugos's source:

1. Create a new branch for your changes (the branch name is arbitrary):

Expand Down

0 comments on commit 312d225

Please sign in to comment.