hugo/docs/content/community/contributing.md

---
aliases:
- /doc/contributing/
- /meta/contributing/
date: 2013-07-01
menu:
  main:
    parent: community
next: /tutorials/automated-deployments
prev: /community/press
title: Contributing to Hugo
weight: 30
---

All contributions to Hugo are welcome. Whether you want to scratch an itch, or simply contribute to the project, feel free to pick something from the roadmap
or contact [spf13](http://spf13.com) about what may make sense
to do next.

You should fork the project and make your changes.  *We encourage pull requests to discuss code changes.*


When you're ready to create a pull request, be sure to:

  * Have test cases for the new code.  If you have questions about how to do it, please ask in your pull request.
  * Run `go fmt`
  * Squash your commits into a single commit.  `git rebase -i`.  It's okay to force update your pull request.
  * Make sure `go test ./...` passes, and `go build` completes.  Our [Travis CI loop](https://travis-ci.org/spf13/hugo) will catch most things that are missing.  The exception: Windows.  We run on Windows from time to time, but if you have access, please check on a Windows machine too.

## Contribution Overview

1. Fork Hugo 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. Commit passing tests to validate changes.
5. Run `go fmt`
6. Squash commits into a single (or logically grouped) commits (`git rebase -i`)
7. Push to the branch (`git push origin my-new-feature`)
8. Create new Pull Request


# Building from source

## Clone locally (for contributors):

    git clone https://github.com/spf13/hugo
    cd hugo
    go get

Because Go expects all of your libraries to be found in either
`$GOROOT` or `$GOPATH`, it's helpful to symlink the project to one
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/hugo
    go run main.go

## Building Hugo

    cd /path/to/hugo
    go build -o hugo main.go
    mv hugo /usr/local/bin/
sanity: move from json to yaml 2013-07-06 23:36:30 +00:00			`---`
Converting front matter to YAML 2014-05-29 22:42:05 +00:00			`aliases:`
			`- /doc/contributing/`
			`- /meta/contributing/`
			`date: 2013-07-01`
Implementing new menu system in the docs site 2014-04-23 07:00:11 +00:00			`menu:`
			`main:`
Converting front matter to YAML 2014-05-29 22:42:05 +00:00			`parent: community`
Tutorial: Automated deployments Also fixed the next/prev for the tutorials 2015-01-12 11:08:20 +00:00			`next: /tutorials/automated-deployments`
Converting front matter to YAML 2014-05-29 22:42:05 +00:00			`prev: /community/press`
			`title: Contributing to Hugo`
			`weight: 30`
YAML support similar to jekyll (start and end with '---') 2013-07-08 21:57:01 +00:00			`---`
adding hugo 2013-07-04 15:32:55 +00:00
Minor proofreading corrections to Hugo docs 2014-08-31 11:08:36 +00:00			`All contributions to Hugo are welcome. Whether you want to scratch an itch, or simply contribute to the project, feel free to pick something from the roadmap`
Complete overhaul of the docs 2013-08-17 12:34:25 +00:00			`or contact [spf13](http://spf13.com) about what may make sense`
Updating / Rewriting / Adding all of the documentation in preparation for the next release 2014-05-27 22:32:57 +00:00			`to do next.`

			`You should fork the project and make your changes. We encourage pull requests to discuss code changes.`

Updating a bunch of the docs 2013-08-03 07:30:34 +00:00
Adding better contribution guidelines from the read me to the contribution page. 2013-12-11 03:23:20 +00:00			`When you're ready to create a pull request, be sure to:`

			`* Have test cases for the new code. If you have questions about how to do it, please ask in your pull request.`
			* Run `go fmt`
			* Squash your commits into a single commit. `git rebase -i`. It's okay to force update your pull request.
[Docs] More copyediting * Add link to https://travis-ci.org/spf13/hugo * Correct heading levels in docs/content/community/mailing-list.md * Mention RFC 3339 as the `date` format set by `hugo new` * Mention that `hugo new` does not add `draft = true` when the user provides an archetype * List short examples of TOML and YAML side by side * Compact the Math template functions into a table * Put some notes into a blockquote 2015-01-17 07:45:53 +00:00			* Make sure `go test ./...` passes, and `go build` completes. Our [Travis CI loop](https://travis-ci.org/spf13/hugo) will catch most things that are missing. The exception: Windows. We run on Windows from time to time, but if you have access, please check on a Windows machine too.
Adding better contribution guidelines from the read me to the contribution page. 2013-12-11 03:23:20 +00:00
			`## Contribution Overview`
Adding community section to the documentation 2013-12-11 00:38:52 +00:00
			`1. Fork Hugo from https://github.com/spf13/hugo`
adding hugo 2013-07-04 15:32:55 +00:00			2. Create your feature branch (`git checkout -b my-new-feature`)
			3. Commit your changes (`git commit -am 'Add some feature'`)
Adding community section to the documentation 2013-12-11 00:38:52 +00:00			`4. Commit passing tests to validate changes.`
Adding better contribution guidelines from the read me to the contribution page. 2013-12-11 03:23:20 +00:00			5. Run `go fmt`
			6. Squash commits into a single (or logically grouped) commits (`git rebase -i`)
			7. Push to the branch (`git push origin my-new-feature`)
			`8. Create new Pull Request`
Adding community section to the documentation 2013-12-11 00:38:52 +00:00
Updating a bunch of the docs 2013-08-03 07:30:34 +00:00
Adding community section to the documentation 2013-12-11 00:38:52 +00:00			`# Building from source`
Updating a bunch of the docs 2013-08-03 07:30:34 +00:00
Using table of contents within the documentation. 2014-01-29 04:29:05 +00:00			`## Clone locally (for contributors):`
Updating a bunch of the docs 2013-08-03 07:30:34 +00:00
			`git clone https://github.com/spf13/hugo`
			`cd hugo`
			`go get`

Minor proofreading corrections to Hugo docs 2014-08-31 11:08:36 +00:00			`Because Go expects all of your libraries to be found in either`
Docs copyediting: Add more external URLs; add backticks, etc. 2014-12-27 07:50:08 +00:00			`$GOROOT` or `$GOPATH`, it's helpful to symlink the project to one
Updating a bunch of the docs 2013-08-03 07:30:34 +00:00			`of the following paths:`

Docs copyediting: Add more external URLs; add backticks, etc. 2014-12-27 07:50:08 +00:00			* `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`
Updating a bunch of the docs 2013-08-03 07:30:34 +00:00
Using table of contents within the documentation. 2014-01-29 04:29:05 +00:00			`## Running Hugo`
Updating a bunch of the docs 2013-08-03 07:30:34 +00:00
			`cd /path/to/hugo`
Doc fix: replace "hugolibs" with "hugo" in "contributing" page, fixes #271. 2014-05-06 06:51:16 +00:00			`go install github.com/spf13/hugo/hugo`
Updating a bunch of the docs 2013-08-03 07:30:34 +00:00			`go run main.go`

Using table of contents within the documentation. 2014-01-29 04:29:05 +00:00			`## Building Hugo`
Updating a bunch of the docs 2013-08-03 07:30:34 +00:00
			`cd /path/to/hugo`
			`go build -o hugo main.go`
			`mv hugo /usr/local/bin/`