Обновить Code/Versioning&Commiting
@@ -1 +1,100 @@
|
|||||||
Добро пожаловать в вики.
|
# Работа с системой контроля версий и версиями игры
|
||||||
|
|
||||||
|
Разделы:\
|
||||||
|
Система контроля версий:
|
||||||
|
- [Начало работы](#начало-работы)
|
||||||
|
- [Рабочий процесс](#рабочий-процесс)
|
||||||
|
- Исправление ошибок
|
||||||
|
- Дополнительно
|
||||||
|
|
||||||
|
|
||||||
|
Версии игры:
|
||||||
|
- _Скоро_
|
||||||
|
|
||||||
|
|
||||||
|
## Система контроля версий
|
||||||
|
|
||||||
|
### Начало работы
|
||||||
|
Как система контроля версий используется `git` в связке с сервером `Gitea`.\
|
||||||
|
Для работы необходимо установить **git**. После чего необходимо открыть консоль в папке где будет лежать код проекта, после чего выполнить:
|
||||||
|
```
|
||||||
|
git lfs install
|
||||||
|
```
|
||||||
|
для инициализации системы работы с большими файлами, после чего необходимо выполнить:
|
||||||
|
```
|
||||||
|
git clone https://git.mr-potato.ru/PotatoPieGames/hexwar.git .
|
||||||
|
```
|
||||||
|
|
||||||
|
для клонирования проекта с сервера в текущую папку.\
|
||||||
|
После этого проект появится в папке которая была открыта в консоли. Для дальнейшей работы необходимо открыть **UnityHub**, в нем необходимо нажать **Add**_(Добавить)_, выбрать папку в которую клонирован проект. Для проекта выбрать версию Unity `2021.3.23f1` или максимально возможно близкую. Затем можно открывать проект в Unity.
|
||||||
|
|
||||||
|
### Рабочий процесс
|
||||||
|
### **Важно!**
|
||||||
|
**Редактирование одной сцены с разных устройств приведет к различиям в сцене, что вызовет конфликт при попытке отгрузки проекта на сервер и приведет к необходимости выбрать только 1 из версий сцены отбросив ВСЕ изменения внесенные с 1 из устройств!**
|
||||||
|
|
||||||
|
- [Внесение изменений](#внесение-изменений)
|
||||||
|
- [Отправка](#отправка-на-сервер)
|
||||||
|
- [Получение](#получение-изменений-с-сервера)
|
||||||
|
- [Краткая памятка](#краткая-памятка-по-командам)
|
||||||
|
|
||||||
|
### Внесение изменений
|
||||||
|
После изменения файлов для выгрузки изменений на сервер необходимо:
|
||||||
|
|
||||||
|
Добавить изменения командой:
|
||||||
|
```
|
||||||
|
git add .
|
||||||
|
```
|
||||||
|
для подготовки изменений в файлах в этой папке и далее к коммиту, далее создаем коммит командой
|
||||||
|
```
|
||||||
|
git commit
|
||||||
|
```
|
||||||
|
после выполнения откроется текстовый редактор сообщения коммита о нем далее. Если нужно создать коммит без открытия текстового редактора можно использовать команду
|
||||||
|
```
|
||||||
|
git commit -m "Сообщение"
|
||||||
|
```
|
||||||
|
если строчек нужно несколько то команда приобретает вид
|
||||||
|
```
|
||||||
|
git commit -m "Первая строка(название)" -m "Вторая строка" -m "Третья строка"
|
||||||
|
```
|
||||||
|
если была допущена ошибка в сообщении или файлах то изменить последний коммит можно командой (если нужно внести изменения в файлы то сначала нужно выполнить `git add`)
|
||||||
|
```
|
||||||
|
git commit --amend
|
||||||
|
```
|
||||||
|
|
||||||
|
### Сообщение коммита
|
||||||
|
В сообщении нужно указать, что поменялось в этом коммите.\
|
||||||
|
Правила составления сообщений:
|
||||||
|
- Английский язык
|
||||||
|
- Первая строка - название коммита, она должна быть короткой и отражать суть изменений в повелительном наклонении. Типа `fix app crashing when opening menu`, `add main menu` и т. п.
|
||||||
|
- Последующие строки расширенное описание, если не хватило первой строки, то расширенное описание можно написать здесь
|
||||||
|
- Сообщение должно отражать, что поменялось
|
||||||
|
- Сообщение не должно быть очень длинным
|
||||||
|
|
||||||
|
### Отправка на сервер
|
||||||
|
Для отправки изменений на сервер после коммита необходимо использовать команду
|
||||||
|
```
|
||||||
|
git push
|
||||||
|
```
|
||||||
|
изменения будут отправлены на сервер. **Можно отправлять по несколько коммитов за раз.**
|
||||||
|
|
||||||
|
### Получение изменений с сервера
|
||||||
|
```
|
||||||
|
git pull
|
||||||
|
```
|
||||||
|
после этого все изменения с сервера будут получены.
|
||||||
|
|
||||||
|
### Краткая памятка по командам
|
||||||
|
Отправка:
|
||||||
|
```
|
||||||
|
git add .
|
||||||
|
```
|
||||||
|
```
|
||||||
|
git commit
|
||||||
|
```
|
||||||
|
```
|
||||||
|
git push
|
||||||
|
```
|
||||||
|
Получение:
|
||||||
|
```
|
||||||
|
git pull
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user