From a10519643d58abe823c17f3d4cd3a9dd26f89403 Mon Sep 17 00:00:00 2001 From: spf13 Date: Tue, 10 Dec 2013 22:23:20 -0500 Subject: [PATCH] Adding better contribution guidelines from the read me to the contribution page. --- docs/content/community/contributing.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/content/community/contributing.md b/docs/content/community/contributing.md index 3630779f..073f2862 100644 --- a/docs/content/community/contributing.md +++ b/docs/content/community/contributing.md @@ -6,21 +6,27 @@ groups: ["community"] groups_weight: 30 --- -We welcome all contributions. If you want to contribute, all -that is needed is simply fork Hugo, make changes and submit -a pull request. **All pull requests must include comprehensive test cases.** -If you prefer, pick something from the roadmap +We welcome all contributions. Feel free to pick something from the roadmap or contact [spf13](http://spf13.com) about what may make sense -to do next. +to do next. Go ahead and fork the project and make your changes. *We encourage pull requests to discuss code changes.* -## Overview +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 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. Push to the branch (`git push origin my-new-feature`) -6. Create new Pull Request +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 -- 2.30.2