Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

update contributing instructions

  • Loading branch information...
commit 58fa44500bededb8a744efa6ff0a111b373030c3 1 parent a86349e
@plusjade plusjade authored
Showing with 13 additions and 1 deletion.
  1. +13 −1 README.md
View
14 README.md
@@ -16,7 +16,19 @@ This repository tracks 2 projects:
- **Jekyll-Bootstrap Framework.**
The framework for which users should clone and build their blog on top of is available in the master branch.
- Please fork and contribute additions to the framework itself here.
+
+ To contribute to the framework please make sure to checkout your branch based on `jb-development`!!
+ This is very important as it allows me to accept your pull request without having to publish a public version release.
+
+ Small, atomic Features, bugs, etc.
+ Use the `jb-development` branch but note it will likely change fast as pull requests are accepted.
+ Please rebase as often as possible when working.
+ Work on small, atomic features/bugs to avoid upstream commits affecting/breaking your development work.
+
+ For Big Features or major API extensions/edits:
+ This is the one case where I'll accept pull-requests based off the master branch.
+ This allows you to work in isolation but it means I'll have to manually merge your work into the next public release.
+ Translation : it might take a bit longer so please be patient! (but sincerely thank you).
- **Jekyll-Bootstrap Documentation Website.**
The documentation website at <http://jekyllbootstrap.com> is maintained in the gh-pages branch.
Please sign in to comment.
Something went wrong with that request. Please try again.