diff --git a/site/docs/contributing.md b/site/docs/contributing.md index b0e0531e..0740e32a 100644 --- a/site/docs/contributing.md +++ b/site/docs/contributing.md @@ -16,13 +16,19 @@ following in mind: * If it's a brand new feature, make sure to create a new [Cucumber](https://github.com/cucumber/cucumber/) feature and reuse steps where appropriate. Also, whipping up some documentation in your fork's `site` - directory would be appreciated, and once merged it will also appear in - the next update of the main site. -* If your contribution adds or changes any Jekyll behavior, make sure to update - the documentation. It lives in `site/docs`. If the docs are missing - information, please feel free to add it in. Great docs make a great project! + would be appreciated, and once merged it will be transferred over to the main + `site`, jekyllrb.com. +* If your contribution changes any Jekyll behavior, make sure to update the + documentation. It lives in `site/docs`. If the docs are missing information, + please feel free to add it in. Great docs make a great project! * Please follow the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby) when modifying Ruby code. +* Please do your best to submit **small pull requests**. The easier the proposed + change is to review, the more likely it will be merged. +* When submitting a pull request, please make judicious use of the pull request + body. A description of what changes were made, the motivations behind the + changes and [any tasks completed or left to complete](http://git.io/gfm-tasks) + will also speed up review time.
Contributions will not be accepted without tests
@@ -47,8 +53,8 @@ Before you start, run the tests and make sure that they pass (to confirm your environment is configured properly): {% highlight bash %} -$ rake test -$ rake features +$ bundle exec rake test +$ bundle exec rake features {% endhighlight %} Workflow @@ -79,8 +85,8 @@ git checkout -b my_awesome_feature git push origin my_awesome_feature {% endhighlight %} -* Create a pull request against mojombo/jekyll and describe what your change - does and the why you think it should be merged. +* Create a pull request against mojombo/jekyll:master and describe what your + change does and the why you think it should be merged. Updating Documentation ----------------------