hugo/docs/content/meta/contributing.md

46 lines
1.2 KiB
Markdown
Raw Normal View History

2013-07-06 19:36:30 -04:00
---
title: "Contributing to Hugo"
2013-08-17 08:34:25 -04:00
date: "2013-07-01"
aliases: ["/doc/contributing/"]
---
2013-07-04 11:32:55 -04:00
2013-08-17 08:34:25 -04:00
We welcome all contributions. If you want to contribute, all
that is needed is simply fork Hugo, make changes and submit
2013-08-03 03:30:34 -04:00
a pull request. If you prefer, pick something from the roadmap
2013-08-17 08:34:25 -04:00
or contact [spf13](http://spf13.com) about what may make sense
2013-08-03 03:30:34 -04:00
to do next.
2013-08-17 08:34:25 -04:00
## Overview
2013-07-04 11:32:55 -04:00
1. Fork it from https://github.com/spf13/hugo
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
2013-08-03 03:30:34 -04:00
### Clone locally (for contributors):
git clone https://github.com/spf13/hugo
cd hugo
go get
2013-08-17 08:34:25 -04:00
Because go expects all of your libraries to be found in either
$GOROOT or $GOPATH, it's helpful to symlink the project to one
2013-08-03 03:30:34 -04:00
of the following paths:
* ln -s /path/to/your/hugo $GOPATH/src/github.com/spf13/hugo
* ln -s /path/to/your/hugo $GOROOT/src/pkg/github.com/spf13/hugo
### Running Hugo
cd /path/to/hugo
go install github.com/spf13/hugo/hugolibs
go run main.go
### Building Hugo
cd /path/to/hugo
go build -o hugo main.go
mv hugo /usr/local/bin/