Работа с системой контроля версий и версиями игры
Разделы:
Система контроля версий:
- Начало работы
- Рабочий процесс
- Исправление ошибок
- Дополнительно
Версии игры:
- Скоро
Система контроля версий
Начало работы
Как система контроля версий используется git в связке с сервером Gitea.
Для работы необходимо установить git. После чего необходимо открыть консоль в папке где будет лежать код проекта, после чего выполнить:
git lfs install
для инициализации системы работы с большими файлами, после чего необходимо выполнить:
git clone https://git.mr-potato.ru/PotatoPieGames/hexwar.git .
для клонирования проекта с сервера в текущую папку.\
После этого проект появится в папке которая была открыта в консоли. Для дальнейшей работы необходимо открыть UnityHub, в нем необходимо нажать Add(Добавить), выбрать папку в которую клонирован проект. Для проекта выбрать версию Unity 2021.3.23f1 или максимально возможно близкую. Затем можно открывать проект в Unity.
Рабочий процесс
Внесение изменений
После изменения файлов для выгрузки изменений на сервер необходимо:
Добавить изменения командой:
git add .
для подготовки изменений в файлах в этой папке и ее подпапках к коммиту, далее создаем коммит командой
git commit
после выполнения откроется текстовый редактор сообщения коммита, о правилах написания сообщения далее. Если нужно создать коммит без открытия текстового редактора можно использовать команду:
git commit -m "Сообщение"
если строк нужно несколько то команда приобретает вид:
git commit -m "Первая строка(название)" -m "Вторая строка" -m "Третья строка"
если была допущена ошибка в сообщении или файлах, то изменить последний коммит можно командой:
git commit --amend
(если нужно внести изменения в файлы то сначала нужно выполнить git add)
Сообщение коммита
В сообщении нужно указать, что поменялось в этом коммите.
Правила составления сообщений:
- Английский язык
- Первая строка - название коммита, она должна быть короткой и отражать суть изменений в повелительном наклонении. Типа
fix app crashing when opening menu,add main menuи т. п. - Последующие строки нужны, если для описания комита не хватило первой строки
- Сообщение должно отражать, изменения произведенные в коммите
- Сообщение не должно быть очень длинным
Отправка на сервер
Для отправки изменений на сервер после коммита необходимо использовать команду:
git push
изменения будут отправлены на сервер. Можно отправлять по несколько коммитов за раз.
Получение изменений с сервера
Для получения изменений необходимо выполнить команду:
git pull
после этого все изменения с сервера будут получены.
Краткая памятка по командам
Отправка:
git add .
git commit
git push
Получение:
git pull