Просмотр кода страницы Руководство по работе с Git

{{DISPLAYTITLE:Руководство по созданию Pull Request}}
[[Категория:Разработка]]
[[Категория:Гайды для контрибьюторов]]

= Руководство по созданию Pull Request =

Данное руководство описывает процесс создания Pull Request (PR) в репозиторий '''Orion Station 14'''. Следование этим правилам ускоряет ревью и снижает вероятность отклонения вашего вклада.

== Подготовка ==

=== Форк и клонирование ===

# Перейдите на [https://github.com/M9SCO/Orion-Station-14 страницу репозитория] и нажмите '''Fork'''.
# Склонируйте свой форк:
<syntaxhighlight lang="bash">
git clone https://github.com/ВАШ_ЛОГИН/Orion-Station-14.git
cd Orion-Station-14
</syntaxhighlight>
<ol start="3">
<li>Добавьте основной репозиторий как upstream:</li>
</ol>
<syntaxhighlight lang="bash">
git remote add upstream https://github.com/M9SCO/Orion-Station-14.git
</syntaxhighlight>
<ol start="4">
<li>Запустите скрипт инициализации подмодулей:</li>
</ol>
<syntaxhighlight lang="bash">
python RUN_THIS.py
</syntaxhighlight>

=== Создание ветки ===

{{Важно|Никогда не работайте напрямую в ветке <code>master</code>. Всегда создавайте отдельную ветку под каждый PR.}}

<syntaxhighlight lang="bash">
git checkout master
git pull upstream master
git checkout -b тип/краткое-описание
</syntaxhighlight>

Примеры имён веток:
* <code>feature/mora-12-gravity-bike</code> — новая фича
* <code>fix/emote-restore</code> — исправление бага
* <code>locale/update-anonymous</code> — изменения локализации
* <code>sprites/new-clothing</code> — добавление спрайтов
* <code>tweak/adminwho-visibility</code> — небольшая правка

== Правила оформления PR ==

=== Заголовок ===

Заголовок PR должен быть коротким и информативным. Используйте префикс, описывающий тип изменений:

{| class="wikitable"
! Префикс !! Назначение !! Пример
|-
| <code>feature:</code> || Новая функциональность || <code>feature: добавить гравибайк Mora-12</code>
|-
| <code>fix:</code> || Исправление бага || <code>fix: восстановить общие эмоции</code>
|-
| <code>tweak:</code> || Небольшая правка/балансировка || <code>tweak: изменить урон бейсбольной биты</code>
|-
| <code>locale:</code> || Изменения локализации || <code>locale: обновить анонимные имена</code>
|-
| <code>sprites:</code> || Добавление/изменение спрайтов || <code>sprites: добавить спрайты гравибайка</code>
|-
| <code>refactor:</code> || Рефакторинг кода || <code>refactor: вынести логику крафта в отдельную систему</code>
|}

{{Внимание|Не используйте общие заголовки вроде «Update файл.txt» или «Global update». Заголовок должен описывать '''суть''' изменений.}}

=== Описание (Body) ===

Каждый PR '''обязан''' содержать описание. Используйте следующий шаблон:

<pre>
## Что изменено
Краткое описание ваших изменений (2–3 предложения).

## Зачем
Причина или мотивация для данного изменения.

## Скриншоты / Медиа
<!-- Если PR затрагивает визуал (спрайты, UI) — приложите скриншоты или GIF -->

## Чеклист
- [ ] Я протестировал(а) изменения локально
- [ ] Код собирается без ошибок
- [ ] Нет конфликтов с веткой master
- [ ] Изменения затрагивают только то, что заявлено в PR
</pre>

== Типичные ошибки ==

=== 1. Дублирование PR ===

{{Внимание|Не создавайте несколько PR с одним и тем же содержимым.}}

Если ваш PR требует доработки — '''обновите существующий''', а не создавайте новый:

<syntaxhighlight lang="bash">
# Внесите исправления в код, затем:
git add .
git commit -m "fix: учтены замечания из ревью"
git push origin ваша-ветка
</syntaxhighlight>

Существующий PR обновится автоматически. Создание дубликатов (как PR #9, #10, #11) засоряет историю и усложняет ревью.

=== 2. Работа в master ===

Работа напрямую в <code>master</code> создаёт конфликты при синхронизации с upstream и не позволяет параллельно вести несколько PR.

=== 3. Слишком большой PR ===

Один PR = одна логическая единица изменений. Не смешивайте в одном PR:
* Новую фичу + рефакторинг стороннего кода
* Спрайты + изменения в C#-коде (если они не связаны)
* Несколько независимых исправлений

=== 4. Отсутствие тестирования ===

Перед созданием PR убедитесь, что:
* Проект собирается (<code>dotnet build</code>)
* Сервер запускается без ошибок
* Ваши изменения работают в игре

== Процесс ревью ==

После создания PR происходит следующее:

# '''Автоматические проверки''' — CI/CD прогоняет сборку и тесты.
# '''Сортировка''' — мейнтейнер выставляет лейблы.
# '''Code Review''' — один или несколько мейнтейнеров проверяют код.
# '''Запрос изменений''' — если есть замечания, от вас ждут коммиты в ту же ветку.
# '''Мерж''' — после одобрения PR вливается в master.

{| class="wikitable" style="background: #f9f9f9;"
! Что делать, если... !! Решение
|-
| CI упал || Прочитайте логи сборки, исправьте ошибки, запушьте фикс в ветку PR
|-
| Появились конфликты || Выполните <code>git pull upstream master</code> и разрешите конфликты локально
|-
| Долго нет ревью || Напишите мейнтейнеру в Discord / оставьте комментарий в PR
|-
| PR отклонили || Прочитайте причину, учтите замечания, создайте новый PR (если старый закрыт) или обновите текущий
|}

== Работа с конфликтами ==

Если ваш PR конфликтует с master:

<syntaxhighlight lang="bash">
git checkout ваша-ветка
git fetch upstream
git merge upstream/master
# Разрешите конфликты в редакторе
git add .
git commit -m "merge: разрешение конфликтов с master"
git push origin ваша-ветка
</syntaxhighlight>

{{Важно|Используйте <code>git merge</code>, а не <code>git rebase</code>, если вы не уверены в том, что делаете. Rebase переписывает историю и может создать проблемы при командной работе.}}

== Полезные ссылки ==

* [https://github.com/M9SCO/Orion-Station-14 Репозиторий Orion Station 14]
* [https://docs.spacestation14.com/ Документация Space Station 14]
* [https://docs.spacestation14.com/en/general-development/setup/setting-up-a-development-environment Настройка окружения разработки]

== Краткая шпаргалка ==

<syntaxhighlight lang="bash">
# 1. Синхронизация с upstream
git checkout master && git pull upstream master

# 2. Создание ветки
git checkout -b feature/моя-фича

# 3. Работа и коммиты
git add файл1 файл2
git commit -m "feature: описание изменения"

# 4. Пуш и создание PR
git push origin feature/моя-фича
# → Перейдите на GitHub и нажмите "Create Pull Request"

# 5. Обновление PR после замечаний
git add .
git commit -m "fix: учтены замечания"
git push origin feature/моя-фича
</syntaxhighlight>