1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/lang3-react-vant

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
CONTRIBUTING.md 5.2 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
Отправлено 06.03.2025 05:28 64c6e10

Гайд по вкладу

Введение

Спасибо за использование React Vant.

Ниже приведены рекомендации по отправке отзывов или кода. Прежде чем создавать issue или pull request, пожалуйста, потратите несколько минут на чтение данного гайда.

Участие в разработке

Локальное развитие

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

# Клонировать репозиторий
git clone https://github.com/3lang3/react-vant.git

# Установка зависимостей
cd react-vant && npm run bootstrap

# Войти в режим разработки, открыть браузер по адресу http://localhost:8080
npm run start

Структура каталога

  • Исходный код компонентов находится в каталоге src, каждый компонент имеет свой каталог.
  • Код сайта с документацией расположен в каталоге docs. При локальном развитии можно запустить сайт документации командой npm run start.

Основные директории проекта:

react-vant
├─ build       # сборка
├─ docs        # документация
├─ packages    # подпакеты
├─ test        # тестирование
└─ typings     # типизация

Добавление нового компонента

При добавлении нового компонента организуйте файлы согласно нижеследующей структуре каталога и настройте имя компонента в файле vant.config.js.

packages/react-vant/src
└─ button
   ├─ demo               # пример кода
   ├─ __test__           # юнит-тестирование
   ├─ index.js           # входной файл компонента
   ├─ style/index.less   # стиль компонента
   ├─ README.md          # документация на русском
   └─ README.en-US.md    # документация на английском
```## Отправка Pull Request

### Нормы Pull Request

Если вы впервые отправляете Pull Request на GitHub, прочитайте следующие статьи для обучения:

- [Как элегантно вносить изменения в GitHub](https://segmentfault.com/a/1190000000736629)
- [Первый вклад в открытый исходный код](https://github.com/firstcontributions/first-contributions/blob/master/translations/README.ru.md)

#### Нормы

- При возникновении проблем, рекомендуется сделать ваш Pull Request достаточно маленьким. Обеспечьте, что один Pull Request решает одну проблему или добавляет одну функцию.
- При добавлении новых компонентов или модификации существующих, обязательно добавьте или измените тестовый код, чтобы обеспечить стабильность кода.
- В Pull Request добавьте подходящее описание и свяжите его с соответствующими issue.

### Процесс Pull Request

1. Fork основной репозиторий, если он уже был forkнут, синхронизируйте последнюю версию основного репозитория.
2. На основе основного репозитория создайте новый ветвь, например `feat-button_color`.
3. Разрабатывайте в новой ветри, после завершения работы, отправьте Pull Request на основной репозиторий в ветвь main.
4. После успешного peer review Pull Request будет объединён в основной репозиторий.
5. Ждите выпуска версии React Vant.

### Синхронизация с последней версией кода

Перед тем как создать Pull Request, пожалуйста, следуйте приведенному ниже процессу для синхронизации с последней версией кода основного репозитория:```bash
# Добавьте основной репозиторий в remote, как основной репозиторий для ветки после создания ветки
git remote add upstream https://github.com/3lang3/react-vant.git

# Получите последние изменения из основного репозитория
git fetch upstream

# Переключитесь на ветку dev
git checkout dev

# Объедините код из основного репозитория
git merge upstream/main

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/lang3-react-vant.git
git@api.gitlife.ru:oschina-mirror/lang3-react-vant.git
oschina-mirror
lang3-react-vant
lang3-react-vant
main