Hexoの開発へのご参加を歓迎します。🤗
開発
Hexoの開発へのご参加を歓迎します。このドキュメントは、そのプロセスを支援します。
始める前に
まず、コントリビューター規約 行動規範 をお読みください。
コーディングスタイルに従ってください
- Google JavaScript スタイルガイドに従ってください。
- ソフトタブを使用し、インデントは2つのスペースを使用してください。
- カンマを先頭にしないでください。
また、Hexoには独自のESLint設定があるため、あなたの貢献がESLintに適合していることを確認してください。
ワークフロー
- hexojs/hexo をフォークしてください。
- リポジトリをあなたのコンピュータにクローンし、依存関係をインストールしてください。
$ git clone https://github.com/<username>/hexo.git |
- フィーチャーブランチを作成してください。
$ git checkout -b new_feature |
- ハッキングを開始してください。
- ブランチをプッシュしてください。
$ git push origin new_feature |
- プルリクエストを作成し、変更内容を記述してください。
注意
package.json
のバージョン番号は変更しないでください。- テストに合格した場合のみ、あなたのプルリクエストはマージされます。提出前にテストを実行することを忘れないでください。
$ npm test |
公式プラグインの更新
また、公式プラグインへのPRやissueも歓迎します。🤗
ドキュメントの更新
Hexoのドキュメントはオープンソースであり、hexojs/siteでソースコードを見つけることができます。
ワークフロー
- hexojs/site をフォークしてください。
- リポジトリをあなたのコンピュータにクローンし、依存関係をインストールしてください。
$ npm install hexo-cli -g # If you don't have hexo-cli installed |
- ドキュメントの編集を開始してください。ライブプレビューのためにサーバーを起動できます。
$ hexo server |
- ブランチをプッシュしてください。
- プルリクエストを作成し、変更内容を記述してください。
翻訳
翻訳に貢献する
現在、翻訳にはCrowdinプラットフォームを使用しています。ここでは、誰でも手動のgit操作なしに翻訳に貢献したり、翻訳に投票したりできます。
新しい言語を追加する
- 新しいissueを提出して、私たちに知らせてください。Crowdinプロジェクトへのアクセス権を持つメンバーが、設定で言語を追加します。
- Crowdinで言語を追加した後、誰でも翻訳に貢献できます。
source/_data/language.yml
に新しい言語を追加してください。themes/navy/languages
にあるen.yml
をコピーし、言語名(すべて小文字)に名前を変更してください。
問題の報告
Hexoの使用中に問題が発生した場合は、トラブルシューティングで解決策を見つけるか、GitHubまたはGoogleグループでお問い合わせください。回答が見つからない場合は、GitHubで報告してください。
- デバッグモードで問題を再現してください。
- GitHubで新しいissueを送信する際は、issueテンプレートの手順に従ってデバッグメッセージとバージョンを提供してください。