Skip to content
This repository has been archived by the owner on Feb 7, 2024. It is now read-only.

Latest commit

 

History

History
92 lines (73 loc) · 3.89 KB

CONTRIBUTING.markdown

File metadata and controls

92 lines (73 loc) · 3.89 KB
Raw

Contribute

So you've got an awesome idea to throw into Jekyll. Great! Please keep the following in mind:

  • Use https://talk.jekyllrb.com for non-technical or indirect Jekyll questions that are not bugs.
  • Contributions will not be accepted without tests or necessary documentation updates.
  • If you're creating a small fix or patch to an existing feature, just a simple test will do. Please stay in the confines of the current test suite and use Shoulda and RSpec-Mocks.
  • If it's a brand new feature, make sure to create a new Cucumber feature and reuse steps 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 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 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 will also speed up review time.

Test Dependencies

To run the test suite and build the gem you'll need to install Jekyll's dependencies. Jekyll uses Bundler, so a quick run of the bundle command and you're all set!

$ bundle

Before you start, run the tests and make sure that they pass (to confirm your environment is configured properly):

$ bundle exec rake test
$ bundle exec rake features

Workflow

Here's the most direct way to get your work merged into the project:

  • Fork the project.
  • Clone down your fork ( git clone git@github.com:<username>/jekyll.git ).
  • Create a topic branch to contain your change ( git checkout -b my_awesome_feature ).
  • Hack away, add tests. Not necessarily in that order.
  • Make sure everything still passes by running rake.
  • If necessary, rebase your commits into logical chunks, without errors.
  • Push the branch up ( git push origin my_awesome_feature ).
  • Create a pull request against jekyll/jekyll and describe what your change does and the why you think it should be merged.

Updating Documentation

We want the Jekyll documentation to be the best it can be. We've open-sourced our docs and we welcome any pull requests if you find it lacking.

You can find the documentation for jekyllrb.com in the site directory of Jekyll's repo on GitHub.com.

All documentation pull requests should be directed at master. Pull requests directed at another branch will not be accepted.

The Jekyll wiki on GitHub can be freely updated without a pull request as all GitHub users have access.

Gotchas

  • If you want to bump the gem version, please put that in a separate commit. This way, the maintainers can control when the gem gets released.
  • Try to keep your patch(es) based from the latest commit on jekyll/jekyll. The easier it is to apply your work, the less work the maintainers have to do, which is always a good thing.
  • Please don't tag your GitHub issue with [fix], [feature], etc. The maintainers actively read the issues and will label it once they come across it.

Finally...

Thanks! Hacking on Jekyll should be fun. If you find any of this hard to figure out, let us know so we can improve our process or documentation!