MA-16519: add contributing.md

docs/CONTRIBUTING.md

@@ -0,0 +1,54 @@
+## Установка
+
+1. Склонировать репозиторий и перейти в созданную директорию.
+2. Установить зависимости:
+```sh
+yarn install
+```
+
+## Запуск и тестирование изменений
+
+vk-mini-apps-router является вспомогательной утилитой, поэтому изменения функционала этой библиотеки следует проверять в связке с вашими мини-приложениями. В папке [examples](../examples/) вы можете увидеть примеры мини-приложений для тестирования или используйте свои собственные приложения. Для локальной проверки ваших изменений мы предлагаем механизм линковки пакетов через symlink.
+
+1. В корне данного проекта выполните команду:
+```sh
+yarn link
+```
+2. В корне приложения, использующего vk-mini-apps-router выполните команду:
+```sh
+yarn link "@vkontakte/vk-mini-apps-router"
+```
+
+## Требования к разработке
+
+- Новые сервисы/утилиты/хуки находятся в отдельных файлах;
+- Используется строгая типизация;
+- Один PR — одна фича/багфикс;
+
+## Проверка кода
+
+Любые изменения в репозитории, должны проходить проверку линтерами. Для этого выполните команду:
+```sh
+yarn lint:ci
+```
+
+## Создание pull request
+
+- Создайте и перейдите в отдельную ветку. Название ветки должно начинаться с указания типа изменения feat для нового функционала или fix для исправления бага и краткой информации о ваших изменениях, например:
+```sh
+git checkout -b fix/fix_useHref_types
+```
+- Добавьте файлы, которые хотите зафиксировать:
+```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-mini-apps-router/pulls) и создайте новый pull request, используя наш шаблон.
+