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

Update CONTRIBUTING docs for better PRs.

This commit is contained in:
Parker Moore 2013-09-12 10:48:42 -04:00
parent c219323384
commit 0090227487
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.markdown
View File

@ -11,14 +11,20 @@ following in mind:
[RR](http://github.com/btakita/rr/tree/master). [RR](http://github.com/btakita/rr/tree/master).
* 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 wiki where appropriate. Also, whipping up some documentation in your fork's `site`
would be appreciated, and once merged it will be transferred over to the main would be appreciated, and once merged it will be transferred over to the main
wiki. `site`, jekyllrb.com.
* If your contribution changes any Jekyll behavior, make sure to update the * If your contribution changes any Jekyll behavior, make sure to update the
documentation. It lives in `site/docs`. If the docs are missing information, 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 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.
Test Dependencies Test Dependencies
----------------- -----------------
@ -32,8 +38,8 @@ you're all set!
Before you start, run the tests and make sure that they pass (to confirm your Before you start, run the tests and make sure that they pass (to confirm your
environment is configured properly): environment is configured properly):
$ rake test $ bundle exec rake test
$ rake features $ bundle exec rake features
Workflow Workflow
-------- --------
@ -65,8 +71,7 @@ All documentation pull requests should be directed at `master`. Pull
requests directed at another branch will not be accepted. requests directed at another branch will not be accepted.
The [Jekyll wiki](https://github.com/mojombo/jekyll/wiki) on GitHub The [Jekyll wiki](https://github.com/mojombo/jekyll/wiki) on GitHub
can be freely updated without a pull request as all can be freely updated without a pull request as all GitHub users have access.
GitHub users have access.
Gotchas Gotchas
------- -------