Внесение изменений в vkui-tokens

Вносить изменения в токены можно с помощью pull request-ов в этот репозиторий на GitHub.

Чтобы ваши изменения попали в основную ветку (master) нужно, чтобы ваш pull request одобрил кто-то из мейнтейнеров репозитория:

Перед отправкой pull request-а на ревью убедитесь, что:

в вашей ветке работает сборка (npm run build:local),
в вашей ветке проходят тесты (npm test),
в вашей ветке проходит линтер (npm run lint), некоторые ошибки можно автоматически поправить с помощью npm run lint:fix,
покрытие тестов не ниже минимального значения,
если вы вносите изменения в задокументированные части библиотеки, ваш pull request содержит обновления документации,
если вы вносите изменения в сами токены, вы согласовали их с дизайнерами.

Для разработки в репозитории может понадобиться установить nodejs не ниже версии 16.

Если вы вносили изменения в цвета, необходимо обновить снапшоты тестов Jest:

npm test -- -u

(Необязательно) Для игнорирование коммитов в git blame, связанные с изменениями стиля кода, необходимо запустить следующую команду:

git config --local blame.ignoreRevsFile .git-blame-ignore-revs

Версионирование

В целом версионирование vkui-tokens придерживается semver.

Критерии формирования новой версии в зависимости от изменений перечислены ниже.

изменение прозрачности цветов (например rgb -> rgba)
локальное изменение размеров в рамках ограниченного числа тем (в release notes обязательно указать, какие токены изменились)
добавление нового токена или новой темы
обратно совместимые изменения инфраструктуры