## Установка

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

```sh
yarn install
```

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

1. Собираем проект:

```sh
yarn build
```

2. Выполняем create-vk-mini-app:

```sh
node bin/create-vk-mini-app.js
```

3. Следуем инструкциям для создания нового приложения;
4. Тестируем созданное приложение.

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

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

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

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

```sh
yarn lint:ci
```

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

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

```sh
git checkout -b feat/add_vk_tunnel_template
```

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

```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/create-vk-mini-app/pulls) и создайте новый pull request, используя наш шаблон.