Skip to content

CONTRIBUTING.MD

Latest commit

 

History

History
51 lines (37 loc) · 3.09 KB

CONTRIBUTING.MD

File metadata and controls

51 lines (37 loc) · 3.09 KB
Raw

Contributing

Требования окружения

  • Node.js 20+ (рекомендуется 22 LTS)
  • Yarn 4.5.3+

Быстрый старт

yarn install --immutable
yarn build
yarn test
yarn lint

Полезные команды разработки

  • Собрать все пакеты: yarn build
  • Прогнать тесты: yarn test
  • Проверить линтинг: yarn lint
  • собрать локально пакет arui-scripts: yarn workspace arui-scripts build

Если вы меняете поведение CLI, то необходимо обновить документацию:

  • packages/arui-scripts/docs/commands.md
  • packages/arui-scripts/docs/cli.md
  • packages/arui-scripts/README.md

Если меняется генератор проектов: packages/create-arui-scripts-app/README.md.

Выпуск релизной версии

Данный проект использует changesets для управления релизами. Каждый пул-реквест, который должен выпустить новый релиз должен содержать файл с описанием изменений в формате changesets. Для этого нужно выполнить команду yarn changeset и ответить на вопросы интерактивного интерфейса (выбор опций делается пробелом). Файл, который будет сгенерирован, нужно добавить в пул-реквест.

ℹ️ При вводе summary в команде yarn changeset стоит указывать с пользовательской точки зрения. Эта информация по итогу попадает в ченжлог.

Примеры хорошего summary:
✅ Исправление реализации префиксов для css правил в модулях
✅ Исправление обработки color-mod функций в css при использовании keepCssVars: false

Примеры некорректного summary:
❌ ignore css order to prevent conflicts

После мержа пул реквеста в мастер, будет создан пул-реквест с новым релизом. После мержа этого пул-реквеста в мастер, будет создан новый релиз в npm.

Выпуск snapshot-версии

Snapshot-версия может быть полезна для тестирования изменений перед релизом. Для ее выпуска можно воспользоваться ручным запуском github action Create snapshot release of packages. Перед запуском github action необходимо не забыть создать changeset командой yarn changeset