Hexo 貢獻(xiàn)

貢獻(xiàn)

開(kāi)發(fā)

我們非常歡迎您加入 Hexo 的開(kāi)發(fā)，這份文件將幫助您了解開(kāi)發(fā)流程。

開(kāi)始之前

請(qǐng)首先閱讀《貢獻(xiàn)者行為準(zhǔn)則》，并確保您不會(huì)違反它。

請(qǐng)使用以下代碼風(fēng)格：

• 遵守 Google JavaScript 代碼風(fēng)格。
• 縮進(jìn)使用 2 個(gè)空格。
• 不要把逗號(hào)放在最前面。

另外，Hexo 擁有自己的 ESLint 配置，因此請(qǐng)確保您的貢獻(xiàn)能夠通過(guò) ESLint。

工作流

1. Fork hexojs/hexo
2. 把庫(kù)（repository）復(fù)制到電腦上，并安裝所依賴的插件。

$ git clone https://github.com/<username>/hexo.git
$ cd hexo
$ npm install
$ git submodule update --init

1. 新增一個(gè)功能分支。

$ git checkout -b new_feature

1. 開(kāi)始開(kāi)發(fā)。
2. 推送（push）分支。

$ git push origin new_feature

1. 建立一個(gè)新的合并申請(qǐng)（pull request）并描述變動(dòng)。

注意事項(xiàng)

• 不要修改 package.json 的版本號(hào)。
• 只有在測(cè)試通過(guò)的情況下您的合并申請(qǐng)才會(huì)被批準(zhǔn)，在提交前別忘了進(jìn)行測(cè)試。

$ npm test

更新 Hexo 官方插件

我們也歡迎給 Hexo 官方插件 提交 PR 和 Issue ????

更新文檔

Hexo 文檔開(kāi)放源代碼，您可以在 hexojs/site找到源代碼。

工作流

1. Fork hexojs/site
2. 把庫(kù)（repository）復(fù)制到電腦上，并安裝所依賴的插件。

$ npm install hexo-cli -g # If you don't have hexo-cli installed
$ git clone https://github.com/<username>/site.git
$ cd site
$ npm install

1. 開(kāi)始編輯文件，您可以通過(guò)服務(wù)器預(yù)覽變動(dòng)。

$ hexo server

1. 推送（push）分支。
2. 建立一個(gè)新的合并申請(qǐng)（pull request）并描述變動(dòng)。

翻譯

1. 在 source 資料夾中建立一個(gè)新的語(yǔ)言資料夾（全小寫(xiě)）。
2. 把 source 資料夾中相關(guān)的文件（Markdown 和模板文件）復(fù)制到新的語(yǔ)言資料夾中。
3. 在 source/_data/language.yml 中新增語(yǔ)言。
4. 將 en.yml 復(fù)制到 themes/navy/languages中并命名為語(yǔ)言名稱（全小寫(xiě)）。

反饋問(wèn)題

當(dāng)您在使用 Hexo 時(shí)遇到問(wèn)題，您可以嘗試在 問(wèn)題解答中尋找解答，或是在 GitHub 或 Google Group 上提問(wèn)。如果你沒(méi)有找答案，請(qǐng)?jiān)?Github 報(bào)告它。

1. 在 調(diào)試模式中重現(xiàn)問(wèn)題。
2. 在 GitHub 上提交 Issue 時(shí)，請(qǐng)遵循 Issue 模板中的步驟提供調(diào)試消息和版本信息。