Для разработчиков

Установка проекта

  • Получить доступы к репозиторию на gitlab
  • Склонировать в рабочую директорию git clone git@gitlab.com:b2bcenter/dev/cds-components.git
  • Перейти в ветку master
    • git checkout master
    • git pull origin master
  • Для работы у вас должна быть установлена актуальная версия Node.js (см. package.json проекта). Для удобной работы с разными версиями ноды на одной машине рекомендуется использовать Node Version Manager. Если он у вас уже установлен, достаточно запустить nvm use в корне проекта для переключения на рекомендуемую версию.
  • Далее пройти в директорию проекта и выполнить в консоли комманду npm install, npm link и cds configure
  • После завершения установки можно запускать проект npm run dev
  • Перейти по адресу

Работа с git

При работе с системой контроля версий применяется спецификация Conventional commits. Это необходимо для соблюдения единообразного и понятного лога, который в т.ч. способствует автоматизации истории релизов и версий компонентов.

Commit

Команда commit производится через CLI, командой cds commit.

При работе с командой, необходимо заполнить несколько параметров:

  • Тип изменений (type)*
  • Область изменений (scope)*
  • Номер задачи*
  • Несовместимые изменения
  • Измененные компоненты

* – обязательные параметры.

После заполнения, необходимо проверить итоговое сообщение на соответствие с правками и подтвердить его (или отклонить) - команда сама закоммитит изменений.

Важно следить и соблюдать соответствие правок, реализованных в коде с сообщением в commit.

Push

Команда push выполняется по стандартному принципу, однако влючает в себя pre-push hook с запуском проверки тестов и сборки. Если понадобится пропустить проверку, необходимо вызвать команду с флагом --no-verify.

Новое мажорное обновление!
Мы активно разрабатываем дизайн систему CDS 3.0 на Vue 3