Участие в проекте 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.

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

При написании тестов мы используем стиль утверждений BDD.

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

Отчеты о багах

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

Запросы на новые возможности

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

Запрос на пулл

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

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

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

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

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

npm install

• Теперь вы можете начать работу, добавить свой код, исправить ошибку или создать новую возможность.

• Чтобы обеспечить функциональную стабильность, вам потребуется написать тесты для вашего кода и пройти тесты. Выполните тесты с помощью следующей команды:

npm run test

• Чтобы гарантировать единство стиля вашего кода, вам следует обратить внимание на спецификации кода и выполнить следующие команды:

npm run lint

• Отправьте запрос на пулл.

Благодарим вас за участие!