Hexo 貢獻(xiàn)

貢獻(xiàn)

開發(fā)

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

開始之前

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

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

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

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

工作流

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

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

1. 新增一個功能分支。

$ git checkout -b new_feature

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

$ git push origin new_feature

1. 建立一個新的合并申請（pull request）并描述變動。

注意事項

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

$ npm test

更新 Hexo 官方插件

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

更新文檔

Hexo 文檔開放源代碼，您可以在 hexojs/site找到源代碼。

工作流

1. Fork hexojs/site
2. 把庫（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. 開始編輯文件，您可以通過服務(wù)器預(yù)覽變動。

$ hexo server

1. 推送（push）分支。
2. 建立一個新的合并申請（pull request）并描述變動。

翻譯

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

反饋問題

當(dāng)您在使用 Hexo 時遇到問題，您可以嘗試在 問題解答中尋找解答，或是在 GitHub 或 Google Group 上提問。如果你沒有找答案，請在 Github 報告它。

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