Skip to content

Latest commit

 

History

History
95 lines (76 loc) · 5.72 KB

CONTRIBUTING.md

File metadata and controls

95 lines (76 loc) · 5.72 KB
Raw

A quick guide to CONTRIBUTING

В этом уникальном гуиде не будет никаких руководств "Как быстро научиться программировать и срать говном на бйонде". Готовьте ваши гиты.

Что я тут делаю?

Очевидно, ты хочешь пропихнуть свой охуенный кусок кода в репозиторий! (Хочешь напилить изменения карты? Сюда!) Так вот. Для того, чтобы сделать это, тебе надо:

  1. Сделать себе форк;
  2. Настроить гит на компьютере;
  3. Понять и запомнить 3 команды;
  4. Насрать пуллреквестом

Делаем форк!

Заходишь сюда и жмешь вверху большую и красивую кнопочку Fork. Форк почти настроен, охуеть!

Ставим гиты!

Жми сюда. Молодец. Ты скачал гит. Установи его! (Git Bash выбери супротив cmd.exe, остальное постанови стандартным)

Отлично. Открывай незабвенную Git Bash и вводи (очевидно, заменяя name и email на реальные):

$ git config --global user.name "[name]"
$ git config --global user.email "[email]"

Например:

$ git config --global user.name "Vasya Pupkin"
$ git config --global user.email "[email protected]"

Охуенно. Теперь открывай страничку своего форка, жми на большую зеленую кнопку Clone or download и копируй ебаную ссылку. Возвращайся к Git Bash.

$ git clone <вставь ссылочку>
$ cd green
$ git remote add upstream https://github.com/animusdev/whiTGreen

Например:

$ git clone https://github.com/vasyapupkin/whiTGreen
$ cd green
$ git remote add upstream https://github.com/animusdev/whiTGreen

Заебись. Твой гит настроен.

Срем говном в свой форк

Итак, у тебя есть гит и свой форк. Для начала перед работой, чтобы спиздить новейшие коммиты:

$ git pull upstream dev

Вносишь изменения и срешь говном. Сделал? Тогда убедись, что твои приключения повлияли только на те файлы, что ты хотел:

$ git status
$ git diff --stat

Если в статистике изменённых строк слишком много - значит, ты сделал что-то не так. Выполни

$ git diff

и проверь все свои изменения построчно. Проверил? Никакого лишнего говна нет? Отлично, можно коммитить.

$ git add .
$ git commit -m "Текст, ёмко описывающий, что ты вообще попытался сделать"
$ git push origin dev

На всякий случай перед этим можно сделать git pull upstream dev, и если снова увидишь vi - можешь не вводить пояснений, это мерж-коммит.

Постарайся умещать одну фичу в один коммит. Не больше и не меньше.

Отлично, ты насрал своими коммитами. Время пропихнуть это в репу.

Пропихиваем говно в репозиторий

Здесь всё куда проще. Открываешь страничку своего форка и жмешь кнопочку New Pull Request. Нажал? Выбирай base-fork'ом animusdev/whiTGreen, а head-fork'ом - свой форк. Вкратце опиши, какие фичи (и баги) были добавлены. Создавай ПР.

Поздравляю, ты успешен! Жди мержа. Или комментариев с гайдлайном по изменению кода в лучшую сторону. Для более полного погружения в гит тебе сюда.

Я пилю изменения карты, что мне делать, чтобы ко мне ночью не пришла вся вайтодевтима и не выебала меня?

Используй мапмержер. Перед правкой карты запусти из репы mapmerge/Prepare Maps.bat. Оно подготовит карты. Внеси изменения и запусти mapmerge/Run Map Merge - DMM.bat. Выбери номера измененных карт. Молодец.

На всякий случай проверь git diff --stat, там не должно быть около 2-5 тысяч измененных строк. Если этих 2-5к там нет - можно коммитить.