Содействие

Разработчикам

Мы рады желающим присоединится к развитию Hexo. Этот документ поможет вам начать.

Прежде чем начать

Пожалуйста, следите за стилем написания кода:

  • Следуйте Google JavaScript Style Guide.
  • Используйте мягкие табы с двойным пробелом.
  • Не ставьте запятую в начале.

Рабочее пространство

  1. Создайте форк hexojs/site

  2. Клонируйте репозиторий на компьютер и установите все зависимости.

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

  3. Создать отдельную ветку.

    $ git checkout -b new_feature

  4. Вносите изменения.

  5. Выгрузите ветку:

    $ git push origin new_feature

  6. Запросите принятие изменений с их описанием.

На заметку

  • Не изменяйте номер версии в package.json.

  • Ваш запрос могут только принять, когда все тесты пройдут. Не забудьте провести испытания перед отправкой.

    $ npm test

Обновление документации

Документация Hexo имеет открытый исходный код, его можно найти по адресу hexojs/site.

Рабочее пространство

  1. Создайте форк hexojs/site

  2. Клонируйте репозиторий на компьютер и установите все зависимости.

    $ git clone https://github.com/<username>/site.git
    $ cd site
    $ npm install

  3. Начать редактировать документацию. Вы можете запустить сервер для просмотра изменений.

    $ hexo server

  4. Выгрузите ветку.

  5. Запросите принятие изменений с их описанием.

Перевод

  1. Добавьте новую папку с языком в папке source. (Всё в нижнем регистре)
  2. Скопируйте markdown фалы и шаблоны из папки source в папку с создаваемым переводом.
  3. Добавьте новый язык в файл source/_data/language.yml.
  4. Скопируйте en.yml в themes/navy/languages и измените имя (всё в нижнем регистре).

Сообщение о проблеме

Если Вы столкнулись с проблемой при использовании Hexo, то можно поискать решения в устранении неполадок или задать вопросы на GitHub или Google Group. Если решения не нашлось, пожалуйста, сообщите об этом на GitHub.

  1. Воспроизведите проблему в режиме отладки debug mode.
  2. Запустите hexo version и прочтите описание версии.
  3. Создайте сообщение об ошибке с отладочными данными и номером используемой версии на GitHub.
Пред