Гайд по вкладу в проект NutUI

1. Выбор темы для участия в вкладе

• Темы с меткой PR Welcome включают следующие типы:
  • 1. Повторяемые ошибки
  • 2. Планируемые реализации функциональностей
• #2220

2. Установка зависимостей проекта

Проект представляет собой монорепозиторий pnpm, поэтому требуется использовать pnpm для установки зависимостей.

Обратите внимание, что файл pnpm-lock.yaml может регулярно обновляться, а также могут меняться необходимые для запуска проекта скрипты. Поэтому рекомендуется каждый раз перед вкладом обновлять до последней версии и выполнять следующую команду:

pnpm i

3. Окружение разработки проекта

А. Запуск документации и демонстрационного приложения H5 (@nutui/nutui)

pnpm dev

• Код находится в директории src/packages/__VUE/
  • Исходный код компонентов: index.vue
  • Русскоязычный документ: doc.md
  • Англоязычный документ: doc.en-US.md
  • Исходный код демо: demo.vue или demo/index.vue

Б. Запуск демонстрационного приложения Taro (@nutui/nutui-taro)

# Taro H5
pnpm dev:h5

# Taro WeChat Mini Program
pnpm dev:weapp

# Другие Mini Programs
pnpm dev:taro jd
pnpm dev:taro alipay
pnpm dev:taro tt
...

• Исходный код компонентов: index.taro.vue
• Документация: doc.taro.md
• Проект демо: packages/nutui-taro-demo

4. Сборка проекта

# Сборка @nutui/nutui, цель сборки находится в директории `publish/nutui`
pnpm build

# Сборка @nutui/nutui-taro, цель сборки находится в директории `publish/nutui-taro`
pnpm build:taro

# Сборка демо-примеров справа от сайта @nutui/nutui
pnpm build:demo

# Сборка демо-примеров справа от сайта @nutui/nutui-taro
pnpm build:h5

# Сборка демо-примеров mini programs @nutui/nutui-taro
pnpm build:weapp

5. Перед созданием Pull Request

Все изменения кода должны пройти через следующие тесты перед коммитом:

# Единичные тесты
pnpm test

# Проверка ESLint
pnpm lint

При коммите, репозиторий автоматически выполняет форматирование Prettier и автоматическое исправление ESLint.

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

6. После создания Pull Request

GitHub Actions автоматически выполняют следующие задачи:

Необходимо пройти:

• Линтер: проверка ESLint.
• Тестирование: проверка единичных тестов.
• Сборка: проверка сборки пакетов и демо.

Рекомендовано пройти:

• Codecov: проверка покрытия единичных тестов.
• CodeFactor: проверка стиля кода.

Дополнительная информация

1. Покрытие единичных тестов

Вы можете выполнить тестирование и сгенерировать данные о покрытии единичных тестов с помощью команды:

pnpm test:c

2. Соответствие демонстрационного кода в документах и исходному коду демо

• Русско-английская документация
• > demo: button plain --> src/packages/__VUE/button/demo/plain.vue
• Документация Taro
• > demo: button plain basic --> packages/nutui-taro-demo/src/basic/pages/button/plain.vue