Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 4.96 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 4.96 KB
Raw

Как помочь в разработке сайта

Проект разрабатывается сообществом и любой может принять участие. Самый простой способ — зайти в список задач и выбрать интересную, которая вам по плечу. Самые простые задачи помечены лейблом «легкотня» и обычно требуют самых базовых навыков. Прежде, чем начать работу над какой-то задачей, расскажите об этом в комментарии. Если что-то пошло не так и задача буксует — расскажите об этом, попросите совета или помощи, вам с радостью помогут.

Необходимые инструменты

Установите Git и Node.js с npm на ваш компьютер.

Рекомендуем установить плагин EditorConfig в ваш редактор. При работе с этим проектом, он настроит ваш редактор по файлу .editorconfig и позволит сохранить общий стиль кода. Также рекомендуем установить плагины Prettier и ESLint для наглядной подсветки и быстрого испраления ошибок прямо в редакторах.

Клонирование и запуск

  1. Форкните этот репозиторий.
  2. Склонируйте свой форк локально: git clone git@github.com:USER/new.git, где USER ваш ник на Гитхабе.
  3. Установите зависимости: npm i, это может занять некоторое время.
  4. Запустите проект на локальном сервере: npm run start
  5. Откройте сайт по адресу http://localhost:8000/.

Работа над задачей

  1. Создайте новую ветку для задачи, над которой собираетесь работать: git checkout -b NAME.
  2. Назовите ветку как-нибудь так, чтобы она описывала суть задачи: fix-my-article.
  3. Внесите изменения, запустите тесты и проверку стиля кода, см. «Локальную разработку» ниже.
  4. Добавьте git add . и закомитьте git commit -m 'Правит ошибки'.
  5. Отправьте изменения на сервер в свой форк: git push.
  6. Откройте свой форк и нажмите кнопку «New Pull Request».
  7. В правом выпадающем списке выберите свою ветку, заполните описание и создайте пулреквест.

После отправки пулреквеста вы можете продолжать отправлять коммиты в нужную ветку своего форка и они будут добавляться к уже созданному пулреквесту. Постарайтесь решать только одну задачу в рамках пулреквеста, для других можно создать новую ветку и открыть ещё один пулреквест.

Команды проекта

Запуск команд в директории проекта npm run и нужная команда, например npm run lint.

Локальная разработка

  • develop (или npm start) запускает локальный сервер на http://localhost:8000/
  • lint:eslint запускает проверку JS-кода по конфигу ESLint.
  • lint:fix исправляет ошибки в JS-коде по конфигу ESlint.
  • prettier проверяет стиль кода по стандартам проекта.
  • prettier:fix исправляет стиль кода по стандартам проекта.
  • lint запускает проверки eslint и prettier.

Сборка продакшена

  • build собирает версию сайта для продакшена.
  • copy:assets копирует все файлы из assets в public.
  • test:deploy запускает сборку продактшена и тестирование.
  • test запускает lint и затем build.