我們歡迎你加入 Hexo 的開發。 🤗
開發
我們非常歡迎您加入 Hexo 的開發,這份文件將幫助您了解開發流程。 This document will help you through the process.
開始之前
請先閱讀 Contributor Covenant Code of Conduct。
Please follow the coding style:
- 遵守 Google JavaScript 代碼風格。
- 使用 2 個空格縮排。
- 不要把逗號放在最前面。
此外,Hexo 有 ESLint 設定,因此請務必確認您的貢獻能夠通過 ESLint。
工作流程
- Fork hexojs/hexo
- Clone the repository to your computer and install dependencies.
$ git clone https://github.com/<username>/hexo.git |
- Create a feature branch.
$ git checkout -b new_feature |
- Start hacking.
- Push the branch:
$ git push origin new_feature |
- Create a pull request and describe the change.
注意事項
- 不要修改
package.json
的版本號。 - 只有在測試通過的情況下您的合併申請才會被核准,在提交前別忘了進行測試。 Don’t forget to run tests before submission.
$ npm test |
更新官方外掛 (official-plugins)
此外,我們歡迎你發 PR 或是 Issue 至official-plugins。 🤗
更新文件
Hexo 文件開放原始碼,您可以在 hexojs/site 找到原始碼。
工作流程
- Fork hexojs/site
- Clone the repository to your computer and install dependencies.
$ npm install hexo-cli -g # If you don't have hexo-cli installed |
- Start editing the documentation. You can start the server for live previewing.
$ hexo server |
- 推送(push)分支。
- Create a pull request and describe the change.
翻譯
- 在
source
資料夾中建立一個新的語言資料夾(全小寫)。 (All lower case) - 把
source
資料夾中相關的檔案(Markdown 和模板檔案)複製到新的語言資料夾中。 - 在
source/_data/language.yml
中新增語言。 - 在
themes/navy/languages
複製en.yml
並命名為語言名稱(全小寫)。
回報問題
當您使用 Hexo 遭遇問題時,可試著在 解決問題 中尋找解答,或是在 GitHub 或 Google Group 詢問。 若找不到答案,請至 GitHub 回報。
- 以 除錯模式 再執行一次。
- 在 GitHub 上提交新 Issue 時,請按照問題模板中的步驟提供除錯資訊和版本資訊。