dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Contributing page in the docs to match the new CONTRIBUTING.markdown. #1537.

This commit is contained in:
Parker Moore 2013-09-14 20:09:26 -04:00
parent 1473448dfd
commit 5355fcf02d
1 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
site/docs/contributing.md
View File

@ -16,13 +16,19 @@ following in mind:
* If it's a brand new feature, make sure to create a new * If it's a brand new feature, make sure to create a new
[Cucumber](https://github.com/cucumber/cucumber/) feature and reuse steps [Cucumber](https://github.com/cucumber/cucumber/) feature and reuse steps
where appropriate. Also, whipping up some documentation in your fork's `site` where appropriate. Also, whipping up some documentation in your fork's `site`
directory would be appreciated, and once merged it will also appear in would be appreciated, and once merged it will be transferred over to the main
the next update of the main site. `site`, jekyllrb.com.
* If your contribution adds or changes any Jekyll behavior, make sure to update * If your contribution changes any Jekyll behavior, make sure to update the
the documentation. It lives in `site/docs`. If the docs are missing documentation. It lives in `site/docs`. If the docs are missing information,
information, please feel free to add it in. Great docs make a great project! please feel free to add it in. Great docs make a great project!
* Please follow the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby) * Please follow the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby)
when modifying Ruby code. 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.
<div class="note warning"> <div class="note warning">
<h5>Contributions will not be accepted without tests</h5> <h5>Contributions will not be accepted without tests</h5>
@ -47,8 +53,8 @@ Before you start, run the tests and make sure that they pass (to confirm your
environment is configured properly): environment is configured properly):
{% highlight bash %} {% highlight bash %}
$ rake test $ bundle exec rake test
$ rake features $ bundle exec rake features
{% endhighlight %} {% endhighlight %}
Workflow Workflow
@ -79,8 +85,8 @@ git checkout -b my_awesome_feature
git push origin my_awesome_feature git push origin my_awesome_feature
{% endhighlight %} {% endhighlight %}
* Create a pull request against mojombo/jekyll and describe what your change * Create a pull request against mojombo/jekyll:master and describe what your
does and the why you think it should be merged. change does and the why you think it should be merged.
Updating Documentation Updating Documentation
---------------------- ----------------------