Склонируйте репозиторий и перейдите в созданный каталог:
git clone [email protected]:VKCOM/vkid-ios-sdk.git
cd vkid-ios-sdkТакже можно сделать копию репозитория через Fork и работать в ней.
Для корректной работы автоформатирования выполните:
sh scripts/install-git-hooks.shВсе команды запускаются из корня проекта.
- Полная сборка проекта:
xcodebuild -scheme VKID -sdk iphonesimulator17.0 -destination "name=iPhone 15"- Прогон тестов:
xcodebuild test -scheme VKIDTests -sdk iphonesimulator17.0 -destination "name=iPhone 15"- Автоформатирование кода:
swiftformat .Все ветки создаются от main.
Для названия веток используйте шаблон:
{username}/{task_type}/{description}/{issue_number}
Где:
- {username} – имя пользователя латиницей, например ivan.ivanov
- {task_type} – feature, если это крупное улучшение, или fix, если исправление бага
- {description} – краткое описание изменений
- {issue_number} – VKIDSDK-XXX для разработчиков VK и ISSUE-XXXХ для внешних пользователей
Пример:
git checkout main
git pull
git checkout -b ivan.ivanov/feature/user-profile-preloading/ISSUE-0000В вебхуке commit-msg проверяется соответствие названия ветки шаблону.
Сообщение в коммите должно соответствовать шаблону:
{issue_number}: {commit_description}
Где:
- {issue_number} – VKIDSDK-XXX для разработчиков VK и ISSUE-XXX для внешних пользователей
- {commit_description} – краткое описание коммита на английском языке
В вебхук commit-msg добавляется линтер, где проверяется соответствие сообщения в коммите шаблону.
Пример:
git add -A
git commit -m "ISSUE-0000: some commit description"Заголовок Merge Request (MR) пропишите по шаблону:
{issue_number}: {commit_description}
Где:
- {issue_number} – VKIDSDK-XXX для разработчиков VK и ISSUE-XXX для внешних пользователей
- {commit_description} – краткое описание коммита на английском языке
Пример:
ISSUE-000: Some issue description
При подготовке MR проверьте себя по чек-листу