github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-01-27 14:41:12 +00:00
Code Issues Projects Releases Packages Wiki Activity

Adding better contribution guidelines from the read me to the contribution page.

Browse source
This commit is contained in:
spf13 2013-12-10 22:23:20 -05:00
parent dd574628a0
commit a10519643d
1 changed files with 14 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/content/community/contributing.md
View file

@ -6,21 +6,27 @@ groups: ["community"]
groups_weight: 30 groups_weight: 30
--- ---
We welcome all contributions. If you want to contribute, all We welcome all contributions. Feel free to pick something from the roadmap
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
or contact [spf13](http://spf13.com) about what may make sense 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 1. Fork Hugo from https://github.com/spf13/hugo
2. Create your feature branch (`git checkout -b my-new-feature`) 2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`) 3. Commit your changes (`git commit -am 'Add some feature'`)
4. Commit passing tests to validate changes. 4. Commit passing tests to validate changes.
5. Push to the branch (`git push origin my-new-feature`) 5. Run `go fmt`
6. Create new Pull Request 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 # Building from source