X Tutup
Skip to content

Commit 58fa445

Browse files
committed
update contributing instructions
1 parent a86349e commit 58fa445

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,19 @@ This repository tracks 2 projects:
1616

1717
- **Jekyll-Bootstrap Framework.**
1818
The framework for which users should clone and build their blog on top of is available in the master branch.
19-
Please fork and contribute additions to the framework itself here.
19+
20+
To contribute to the framework please make sure to checkout your branch based on `jb-development`!!
21+
This is very important as it allows me to accept your pull request without having to publish a public version release.
22+
23+
Small, atomic Features, bugs, etc.
24+
Use the `jb-development` branch but note it will likely change fast as pull requests are accepted.
25+
Please rebase as often as possible when working.
26+
Work on small, atomic features/bugs to avoid upstream commits affecting/breaking your development work.
27+
28+
For Big Features or major API extensions/edits:
29+
This is the one case where I'll accept pull-requests based off the master branch.
30+
This allows you to work in isolation but it means I'll have to manually merge your work into the next public release.
31+
Translation : it might take a bit longer so please be patient! (but sincerely thank you).
2032

2133
- **Jekyll-Bootstrap Documentation Website.**
2234
The documentation website at <http://jekyllbootstrap.com> is maintained in the gh-pages branch.

0 commit comments

Comments
 (0)
X Tutup