## Установка

1. Склонировать репозиторий и перейти в созданную директорию.
2. Установить зависимости:

```sh
yarn install
```

## Запуск и тестирование изменений

vk-tunnel является вспомогательной утилитой, поэтому изменения функционала этой библиотеки следует проверять в связке с вашими мини-приложениями. Для локальной проверки ваших изменений вы можете использовать механизм линковки пакетов через symlink.

1. В корне данного проекта выполните команду:

```sh
yarn link
```

2. В корне приложения, использующего vk-tunnel, выполните команду:

```sh
yarn link "@vkontakte/vk-tunnel-client"
```

## Требования к разработке

- Новые утилиты/хэлперы находятся в отдельных файлах;
- Используется строгая типизация;
- Один PR — одна фича/багфикс;

## Проверка кода

Любые изменения в репозитории, должны проходить проверку линтерами. Для этого выполните команду:

```sh
yarn lint:ci
```

## Создание pull request

- Создайте и перейдите в отдельную ветку. Название ветки должно начинаться с указания типа изменения feat для нового функционала или fix для исправления бага и краткой информации о ваших изменениях, например:

```sh
git checkout -b fix/fix_vk_tunnel_on_window
```

- Добавьте файлы, которые хотите зафиксировать:

```sh
git add <file_name>
```

- Commit message должен начинаться с указания типа изменения feat для нового функционала или fix для исправления бага, а так же содержать описание изменения, которое вы вносите.

```sh
git commit -m "[feat/fix]: commit message"
```

- Выполните пуш ваших изменений в новую ветку:

```sh
git push
```

- Перейдите в раздел [Pull requests](https://github.com/VKCOM/vk-tunnel-client/pulls) и создайте новый pull request, используя наш шаблон.