貢獻(xiàn)

是不是有個(gè)點(diǎn)子想實(shí)現(xiàn)到 Jekyll 。太好了，請(qǐng)參照如下： Great! Please keep the following in mind:

• 如果你要在已有的特性上做一個(gè)小修補(bǔ)，只需要寫(xiě)一個(gè)簡(jiǎn)單的 test 就可以了。在當(dāng)前測(cè)試中使用 Shoulda 和 RR.

• 如果是一個(gè)新特性，請(qǐng)寫(xiě)一個(gè)新的 Cucumber 并在 適當(dāng)?shù)牡胤街赜貌襟E。同樣，你也可以大膽的修改你對(duì)本網(wǎng)站的拷貝，一旦被合并掉，就會(huì)展示到網(wǎng)站 jekyllrb.com 。

• 如果你改變了 Jekyll 的習(xí)慣，不要忘了及時(shí)更新文檔。在 site/docs 里邊。如果發(fā)現(xiàn)文檔中缺失的信息， 趕快加上吧。偉大的文檔早就偉大的項(xiàng)目！

• 當(dāng)修改 Ruby 代碼的時(shí)候，請(qǐng)遵照 GitHub Ruby 編碼規(guī)范。

• 請(qǐng)盡可能的提交 小的 pull request 。修改內(nèi)容看起來(lái)越簡(jiǎn)單，就越可能被合并到主分支。

• 當(dāng)提交 pull request 時(shí)，要知道什么地方放什么東西。描述一下做了哪些修改，背后的動(dòng)機(jī)以及 完成了什么任務(wù)或有待完成的都會(huì)加快復(fù)核。

不接受沒(méi)有測(cè)試的代碼

如果你要在已有的特性上做一個(gè)小修補(bǔ)，只需要寫(xiě)一個(gè)簡(jiǎn)單的 test 就可以了。

測(cè)試依賴(lài)

想要跑測(cè)試用例和編譯 gem 的話，你需要安裝 Jekyll 的依賴(lài)包。Jekyll 支持 Bundler ，所以只需要運(yùn) 行一下 bundle 就可以了。

$ bundle

在開(kāi)始之前，跑一下測(cè)試代碼以確信全部通過(guò)（確定一下你的環(huán)境配置好了）：

$ bundle exec rake test
$ bundle exec rake features

Workflow

這是最直接的途徑： the most direct way to get your work merged into the project:

• Fork 本項(xiàng)目。
• 從你的fork下載到本地：

git clone git://github.com/<username>/jekyll.git

• 創(chuàng)建一個(gè)分支，包含要修改的內(nèi)容：

git checkout -b my_awesome_feature

• 添加測(cè)試。
• 通過(guò)命令 rake 確定所有測(cè)試依然全部通過(guò)。
• 如果有必要，將你的提交合并到邏輯塊里邊，不能有錯(cuò)誤。
• 可以推送本分支了：

git push origin my_awesome_feature

• 同 mojombo/jekyll:master 對(duì)比并創(chuàng)建一個(gè) pull request ，描述一下你改了什么還有你為什么認(rèn)為 他們會(huì)合并你的代碼。

更新文檔

我們希望 Jekyll的文檔盡可能的優(yōu)秀。我們已經(jīng)開(kāi)源了所有文檔，歡迎提交修改。

你可以在這里找到 jekyllrb.com 的文檔。

所有針對(duì)文檔的 pull requests 都要放在 master 。不允許提交到其他分支。

Github 上的 Jekyll wiki可以自由更新，不需要 pull request， 任何人都可以修改。

陷阱

• 如果你想修改 gem 版本，請(qǐng)放在一個(gè)獨(dú)立的提交里邊。如此，維護(hù)人員方便管理一些。

• 盡量讓你分支中的代碼是最新的。

• 不要在你的 GitHub issue 用 [fix], [feature] 等標(biāo)記。維護(hù)人員會(huì)積極的閱讀 issues，一 旦碰到他們會(huì)主動(dòng)標(biāo)記。

幫助我們做的更好

Both不管使用還是為 Jekyll 貢獻(xiàn)代碼，都應(yīng)該是有趣的、簡(jiǎn)單的、輕松的，所以如果你發(fā)現(xiàn)有什么不適， 請(qǐng)?jiān)?Github 上 提交一個(gè) issue 。