README.md

BEM Forms Library

Библиотека компонент для создания форм.

• Состав
  • Уровни
  • Блоки
• Использование
• Поддерживаемые браузеры
• Разработка
  • Рабочая копия
  • Внесение изменений
  • Модульное тестирование

Состав

Уровни

• common.blocks — поддержка всех устройств и браузеров.
• desktop.blocks — поддержка всех десктопных браузеров.
• touch.blocks — реализация специфических особенностей для touch-платформ.

Блоки

• form
• form-field
• label
• message
• validation

Разработка

Рабочая копия

Получаем исходники:

$ git clone git://github.com/bem-incubator/bem-forms.git
$ cd bem-forms

Устанавливаем зависимости:

$ npm install

Для последующего запуска локально установленных enb нам потребуется export PATH=./node_modules/.bin:$PATH или любой альтернативный способ.

Устанавливаем зависимые библиотеки:

$ bower install

Собираем примеры и тесты:

$ npm run build-all

Запускаем сервер для разработки:

$ npm start
$ open http://localhost:8080/

Проверяем стиль кода:

$ npm run lint

Внесение изменений

1. Создать issue с описанием сути изменений.
2. Определить, в какую версию проекта необходимо внести изменения.
3. Создать отдельную ветку с указанием номера issue и версии (issues/<номер issue>@v<номер версии>) на основе ветки версии. Например, для issue с номером 42 и версией 2: git checkout -b issues/42@v2. Если изменения нужно внести в несколько версий, то для каждой из версий создается отдельная ветка.
4. Внести изменения. Локально проверить, что ничего не сломалось, запустив npm test.
5. Сделать коммит и отправить изменения в удаленный репозиторий (push). Если это необходимо, то нужно сделать rebase от базовой ветки версии.
6. Создать pull request на основе созданной ветки. Для случая изменений в нескольких версиях необходимо создать pull request для каждой версии.
7. Любым способом связать pull request и issue (например, c помощью комментария).
8. Ждать закрытия pull request и issue ;-)

MIT Лицензия