ref: 357ab956ea4ec07fa6f4098948fbda53f02294b6
parent: 0e04b9a0292732c20cc90e1f05c2f4ee200634d8
author: Noah Campbell <[email protected]>
date: Sat Dec 7 15:48:17 EST 2013
Add Contribution Guidelines Fixes #122
--- a/README.md
+++ b/README.md
@@ -83,4 +83,14 @@
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).**