From 357ab956ea4ec07fa6f4098948fbda53f02294b6 Mon Sep 17 00:00:00 2001 From: Noah Campbell Date: Sat, 7 Dec 2013 20:48:17 -0800 Subject: [PATCH] Add Contribution Guidelines Fixes #122 --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index b5ef7a292..b6575a23b 100644 --- a/README.md +++ b/README.md @@ -83,4 +83,14 @@ If you only want to build from source, it's even easier. go install github.com/spf13/hugo/hugolibs go run main.go +#### Contribution Guidelines + +We welcome your contributions. To make the process as seamless as possible, we ask for the following: + +* Go ahead and 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. + * 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 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. + **Complete documentation is available at [Hugo Documentation](http://hugo.spf13.com).**