🐾Git

Порядок настройки Git и Unreal Engine

1. Создать проект на Unreal Engine 5 (аналогичное имя будет и у будущего репозитория)

2. Создать новый репозиторий через GitHub Desktop (при создании репозитория стоит автоматически добавить .gitignore для Unreal Engine и README.md), указав директорию с созданным проектом

3. Добавить необходимые хуки (например, для вызова clang-format перед commit)

4. Добавить LFS (git lfs install)

5. Добавить следующие строки в .gitattributes (при необходимости создать файл в корне проекта):

# UE file types
*.uasset filter=lfs diff=lfs merge=lfs -text
*.umap filter=lfs diff=lfs merge=lfs -text

# Raw Content types
*.fbx filter=lfs diff=lfs merge=lfs -text
*.3ds filter=lfs diff=lfs merge=lfs -text
*.psd filter=lfs diff=lfs merge=lfs -text
*.png filter=lfs diff=lfs merge=lfs -text
*.mp3 filter=lfs diff=lfs merge=lfs -text
*.wav filter=lfs diff=lfs merge=lfs -text
*.xcf filter=lfs diff=lfs merge=lfs -text
*.jpg filter=lfs diff=lfs merge=lfs -text

1. Сделать Initial commit (возможно, надо будет применить git commit --amend, если commit уже был сделан при создании репозитория через GitHub Desktop) и push

2. Дальше можно использовать, например, Sourcetree

Правила ведения репозитория с Unreal Engine

1. Основная ветка называется master

2. Ветка для разработки называется dev

3. Merge с master происходит только для стабильного и протестированного кода из dev и только с помощью Pull Request в конце итерации

4. Для добавления новой функциональности (или исправления бага) делается ответвление от dev, а в конце работы новая ветка сливается с dev и удаляется

5. Нельзя использовать ветки повторно, за исключением master и dev

6. Коммиты должны делаться часто. Например, нужно добавить новую функцию в проект. В качестве первого шага нужно переименовать несколько файлов. После чего нужно сделать коммит. Затем нужно внести необходимые изменения. Снова коммит. Обновить документацию. Опять коммит. Нужно думать о том, что вкладывается в коммит. Размер коммита имеет второстепенное значение.

Правила по именованию сообщений коммитов и веток

1. В сообщении коммита всегда должно использоваться повелительное наклонение

2. В сообщении коммита обязательно должен быть указан тип: feat (новая функция или улучшение), fix (исправление ошибки), docs (обновление документации), chore (изменения, затрагивающие инструменты, такие как git), test (добавление или изменение тестов), refactor (рефакторинг)

3. Сообщение коммита должно содержать только строчные буквы, за исключением имён собственных и аббревиатур

4. Пример сообщения коммита: fix: correct question count in quiz (#6174)

5. Пример названия ветки: mr/1618/remove-typos-in-documentation - где mr - это инициалы автора, 1618 - id карточки (тикета), remove-typos-in-documentation - описание задачи.

Использование LFS

Для крупных файлов обязательно нужно использовать Git LFS: https://git-lfs.com/

Как добавить в .gitignore ранее отслеживаемый файл?

1. Удалить файл из индекса с помощью git rm --cached filename

2. Сделать коммит, чтобы зафиксировать это удаление

3. Внести этот файл в .gitignore

4. Сделать коммит, обновляющий .gitignore

Полезные команды Git

Основные команды

git init - инициализация репозитория

git add a.txt - добавление в индекс файла a.txt

git commit -m "Initial commit" - создание коммита с сообщением "Initial commit"

git commit --amend -m "Initial commit" - обновляет последний коммит

git checkout abc - "откат" к коммиту abc

Анализ

git status - вывод состояния репозитория

git log --oneline --all --graph - вывод всего лога репозитория

git diff - вывод разницы между рабочим каталогом и индексом

git diff --staged - вывод разницы между индексом и объектной базой данных

git diff HEAD~ HEAD - вывод разницы между предыдущим коммитом и текущим

git tag -l - вывод всех тегов

Отмена изменений

git rm a.txt - удаляет файл из индекса и рабочего каталога

git restore a.txt - восстановление файла a.txt в рабочем каталоге из индекса

git restore --staged a.txt - восстановление файла a.txt в индексе из объектной базы данных

git reset HEAD~ --soft - отмена последнего коммита (рабочий каталог и индекс восстанавливаются к моменту непосредственно предшествующему коммиту)

git reset HEAD~ - отмена последнего коммита (рабочий каталог и индекс восстанавливается до непосредственного добавления изменений в индекс, по сути, индекс и объектная база данных выглядят, как при предыдущем коммите)

git reset HEAD~ --hard - полное восстановление к предыдущему коммиту с потерей всех изменений, внесённых после него

Управление ветками

git branch - вывод всех локальных веток (без веток слежения)

git branch -a - вывод всех веток (включая ветки слежения)

git branch abc - создание ветки abc

git switch abc - переключение на ветку abc

git merge abc - слияние ветки abc с текущей веткой

git branch -m master main - изменение имени ветки с master на main

git branch -d abc - удаление ветки abc

git push - загрузка текущей ветки (и её коммитов) на удалённый сервер

git push -u origin abc - загрузка новой ветки abc (и её коммитов) на удалённый сервер с псевдонимом origin

git fetch -p - извлечение всех веток с сервера (флаг -p нужен для пометки веток, которые были удалены на сервере) и коммитов без сдвига локальных веток

git tag v1.0.0 - создание тега "v1.0.0" для текущего коммита

git stash - припрятывание изменений (особенно полезно, если они были не в той ветке)

git stash pop - восстановление изменений

Схема командной работы в Git