Внесение вклада

Мы рады, что вы заинтересованы в внесении вклада в Semi UI. Пожалуйста, потратите несколько минут на чтение следующих руководств:

Управление ветками

Команда Semi будет поддерживать две основные ветки: main и release. Мы будем выпускать код согласно нашему Периоду публикаций:

• main: Эта ветка является снимком последней стабильной версии. После выпуска минорной версии мы будем объединять release в эту ветку.
• release: Исправления ошибок и развитие новых функций будут первоначально сливаться в эту ветку, новая версия будет выпущена на основе этой ветки в день выпуска.

Ошибки

Мы используем GitHub Issues для отслеживания ошибок. Чтобы быстрее понять и исправить ошибки, при отчете об ошибке рекомендуется воспроизводить проблему через шаблон, который мы предоставляем.

Новые возможности

Если у вас есть идеи по внедрению или оптимизации функций, мы рекомендуем использовать GitHub Issues для предложения нового вопроса.

Руководство по Pull Requests

Команда Semi Design рассматривает каждый Pull Request серьезно. Мы будем проверять и объединять ваш код. Также возможно предложить некоторые изменения в вашем коде. Чтобы открыть Pull Request, пожалуйста, следуйте шагам ниже: - Создайте форк нашего репозитория, затем клонируйте свой форк

git clone https://github.com/<ваш_пользователь>/semi-design.git
cd semi-design

• Выберите тематическую ветку

git checkout -b <TOPIC_BRANCH_NAME>

Прежде чем установить окружение, убедитесь, что локально установлены зависимости lerna и yarn. Если нет, выполните команды:

corepack enable
npm install --global lerna@6
``` - Установите зависимости
```bash
npm run bootstrap

• Далее сделайте необходимые изменения, которые могут быть исправлением ошибок или развитием новых функций.
• Вы можете проверить ваши изменения, запустив Storybook (npm start) и официальный сайт (npm run docsite) локально.
• Добавьте тесты для ваших изменений, убедитесь, что все тесты проходят.

npm run test:unit

• Откройте Pull Request против release исходного репозитория.

Мы можем попросить или помочь вам внести изменения в PR в зависимости от ситуации. Для некорректных PR мы закроем его с объяснением. Если ваши изменения связаны со стилистическими изменениями или изменениями Design Tokens, пожалуйста, прочитайте Спецификацию Semi SCSS Variable Writing/File Citation.

Помогите улучшить документацию

Сайт с документацией основан на Gatsby, а код находится в директории src.

Документация компонентов расположена в md-файле внутри папки с компонентами semi-ui. В качестве примера рассмотрим Tooltip:

• Китайская версия документации packages/semi-ui/tooltip/index.md
• Английская версия документации packages/semi-ui/tooltip/index-en-US.md

Чтобы начать работу:

npm run docsite

Если вы хотите помочь нам улучшить документацию, пожалуйста, измените md-файл компонента и отправьте свои изменения согласно правилам создания pull request.