貢献

私達は、Hexoの開発への参加を歓迎しています。🤗

開発

私達は、Hexoの開発への参加を歓迎しています。この文書は、そのプロセスをサポートします。

始める前に

まず、Contributor Covenant Code of Conductをお読みください。

コーディングスタイルに従ってください:

  • Google JavaScript スタイルガイドに従ってください。
  • ソフトタブを使用し、2スペースのインデントを使ってください。
  • コンマを先頭に置かないでください。

また、Hexoには独自のESLint設定があるため、貢献の際はESLintのルールに従っていることを確認してください。

ワークフロー

  1. hexojs/hexoをフォークします。
  2. リポジトリをコンピューターにクローンし、依存関係をインストールします。
$ git clone https://github.com/<username>/hexo.git
$ cd hexo
$ npm install
$ git submodule update --init
  1. ブランチを作成します。
$ git checkout -b new_feature
  1. 開発を開始します。
  2. ブランチをプッシュします:
$ git push origin new_feature
  1. プルリクエストを作成し、変更内容を説明します。

注意

  • package.jsonのバージョン番号は変更しないでください。
  • プルリクエストは、テストが通った場合にのみマージされます。提出前にテストを実行してください。
$ npm test

公式プラグインの更新

公式プラグインに対するプルリクエストやIssueも歓迎します。🤗

ドキュメントの更新

Hexoのドキュメントはオープンソースで、ソースコードはhexojs/siteで見つけることができます。

ワークフロー

  1. hexojs/siteをフォークします。
  2. リポジトリをコンピューターにクローンし、依存関係をインストールします。
$ npm install hexo-cli -g # hexo-cliがインストールされていない場合
$ git clone https://github.com/<username>/site.git
$ cd site
$ npm install
  1. ドキュメントの編集を始めます。ライブプレビューのためにサーバーを起動することができます。
$ hexo server
  1. ブランチをプッシュします。
  2. プルリクエストを作成し、変更を説明します。

翻訳

  1. sourceフォルダ内に新しい言語フォルダを追加します。（すべて小文字）
  2. sourceフォルダのマークダウンとテンプレートファイルを新しい言語フォルダにコピーします。
  3. source/_data/language.ymlに新しい言語を追加します。
  4. themes/navy/languages内のen.ymlをコピーし、言語名（すべて小文字）にリネームします。

問題の報告

Hexoの使用中に問題に遭遇した場合、トラブルシューティングで解決策を見つけるか、GitHubやGoogle Groupで質問してください。解決策が見つからない場合は、GitHubで報告してください。

  1. デバッグモードで問題を示してください。
  2. 新しい問題をGitHubで作成するときは、Issueテンプレートの手順に従い、デバッグメッセージとバージョンを提供してください。
Prev