Created
October 28, 2015 01:04
-
-
Save ondine/bd0474a0cd47619bb541 to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Workflow | |
| -------- | |
| Here's the most direct way to get your work merged into the project: | |
| * Fork the project. | |
| * Clone down your fork ( `git clone [email protected]:[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 `script/cibuild`. | |
| * 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](https://github.com/jekyll/jekyll/tree/master/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](https://github.com/jekyll/jekyll/wiki) on GitHub | |
| can be freely updated without a pull request as all GitHub users have access. | |
| If you want to add your plugin to the | |
| [list of plugins](http://jekyllrb.com/docs/plugins/#available-plugins), | |
| please submit a pull request modifying the | |
| [plugins page source file](site/_docs/plugins.md) by adding a | |
| link to your plugin under the proper subheading depending upon its type. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment