Участие в развитии RSUITE

RSUITE стремится получать помощь от сообщества, чтобы стать лучше. В этой статье вы узнаете, как помочь RSUITE.

Разработка

Создайте форк этого репозитория в вашем пространстве имён и клонируйте его на локальной машине.

$ git clone git@github.com:<ВАШЕ_ИМЯ>/rsuite.git
$ cd rsuite

Установите зависимости в корневой директории и в директории docs/.

$ npm i && npm i --prefix docs

Теперь вы можете запустить сервер разработки командой npm run dev в директории docs/. По умолчанию он работает по адресу http://127.0.0.1:3000/.

$ npm run dev --prefix docs

Тестирование

При большинстве случаев вам следует убедиться, что ваши изменения не нарушают тесты. Выполните команду npm run tdd в корневой директории для запуска юнит-тестов.

$ npm run tdd

Вы также можете запускать тесты только для одного компонента, установив переменную окружения M.

# запуск тестов только для директории src/Button
$ M=Button npm run tdd

Или для нескольких компонентов. M поддерживает любые шаблоны glob.

# запуск тестов для директорий src/Button и src/ButtonGroup
$ M={Button,ButtonGroup} npm run tdd

Когда вы пишете тесты, мы используем стиль BDD-утверждений.

expect(instance).to.have.class('class-in');

Отчет о багах

Мы собираем все ошибки через GitHub Issues и управляем их там. Если вы нашли ошибку, сообщите нам через GitHub Issues.

Новые требования

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

Pull Request

Мы внимательно проверяем каждый Pull Request, если он соответствует нашим требованиям, то он будет объединен с основной веткой.

Необходимо следовать следующему процессу:

• Создайте форк проекта и клонируйте его.

git clone https://github.com/<ваше-имя>/rsuite.git
# Перейдите в новую папку
cd rsuite

• Если вы ранее клонировали этот проект, обновите его из основного репозитория:

git fetch upstream

• Установите зависимости проекта, выполнив команду в корневой директории:

npm install

• Добавьте свой код, это может быть исправление ошибки или добавление нового функционала.
• Чтобы убедиться в работоспособности вашего кода, выполните тесты, используйте команду:

npm run test

• Чтобы обеспечить единство стиля кода, выполните команду:

npm run lint

• Отправьте Pull Request.

Наконец, спасибо за ваше участие.