Добро пожаловать в команду разработчиков Hexo. 🤗
Разработчикам
Мы рады желающим присоединиться к развитию Hexo. Этот документ поможет вам начать.
Прежде, чем начать
Пожалуйста сначала прочтите Contributor Covenant Code of Conduct.
Убедительно просим, следите за стилем написания кода:
- Следуйте Google JavaScript Style Guide.
- Используйте мягкие табы с двойным пробелом.
- Не ставьте запятую в начале.
Кроме того, у Hexo есть своя собственная конфигурация ESLint config, поэтому, пожалуйста, убедитесь, что ваш вклад пройдёт ESLint проверку.
Workflow
- Создайте форк hexojs/site
- Клонируйте репозиторий на компьютер и установите все зависимости.
$ git clone https://github.com/<username>/hexo.git |
- Создать отдельную ветку.
$ git checkout -b new_feature |
- Start hacking.
- Push the branch:
$ git push origin new_feature |
- Запросите принятие изменений с их описанием.
На заметку
- Не изменяйте номер версии в
package.json
. - Ваш запрос могут только принять, когда все тесты пройдут. Не забудьте провести испытания перед отправкой.
$ npm test |
Обновление официальных плагинов
Также мы будем рады PR или задачам на странице официальных плагинов. 🤗
Обновление документации
Документация Hexo имеет открытый исходный код, его можно найти по адресу hexojs/site.
Workflow
- Создайте форк hexojs/site
- Клонируйте репозиторий на компьютер и установите все зависимости.
$ npm install hexo-cli -g # If you don't have hexo-cli installed |
- Начать редактировать документацию. Вы можете запустить сервер для просмотра изменений.
$ hexo server |
- Выгрузите ветку.
- Запросите принятие изменений с их описанием.
Перевод
- Добавьте новую папку с языком в папке
source
. (Всё в нижнем регистре) - Скопируйте markdown файлы и шаблоны из папки
source
в папку с создаваемым переводом. - Добавьте новый язык в файл
source/_data/language.yml
. - Скопируйте
en.yml
вthemes/navy/languages
и измените имя (всё в нижнем регистре).
Сообщение о проблеме
Если Вы столкнулись с проблемой при использовании Hexo, то можно поискать решения в устранении неполадок или задать вопросы на GitHub или Google Group. Если решения не нашлось, пожалуйста, сообщите об этом на GitHub.
- Воспроизведите проблему в режиме отладки debug mode.
- Следуйте инструкциям из шаблона issue, чтобы предоставить сообщение об отладке и версию при создании нового issue на GitHub.