A quick guide to CONTRIBUTING

Материал из Chaotic Onyx
Версия от 16:00, 1 октября 2019; -7XX- (обсуждение | вклад) (Форматирование странички.)
Перейти к навигацииПерейти к поиску

A quick guide to CONTRIBUTING. Опухшая версия

Начало начал

В этом уникальном гайде не будет никаких руководств «Как быстро научиться программировать и срать говном на байонде». Готовьте ваши гиты.
Что я тут делаю? Очевидно, ты хочешь пропихнуть свой охуенный кусок кода в репозиторий! Так вот. Для того, чтобы сделать это, тебе надо:

  • Сделать себе форк;
  • Настроить гит на компьютере;
  • Понять и запомнить 3 команды;
  • Насрать пуллреквестом
  • Делаем форк!
    • Заходишь сюда и жмешь вверху большую и красивую кнопочку Fork. Форк почти настроен, охуеть!
    • Ставим гиты! Жми сюда -> https://git-scm.com/download/win. Молодец.
    • Ты скачал гит. Установи его! (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 "vasya@pupkins.org"`` Охуенно.
    • Теперь открывай страничку своего форка, жми на большую зеленую кнопку Clone or download и копируй ебаную ссылку.
    • Возвращайся к Git Bash. $ git clone <вставь ссылочку> $ cd OnyxBay $ git remote add upstream https://github.com/ChaoticOnyx/OnyxBay%60%60%60
      Например: $ git clone https://github.com/vasyapupkin/OnyxBay $ cd OnyxBay $ git remote add upstream https://github.com/ChaoticOnyx/OnyxBay Заебись.


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

GitHub

ChaoticOnyx/OnyxBay

Main repository with actual Space Station 13 sources. Branch of Baystation 12. - ChaoticOnyx/OnyxBay

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

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

  • $ git pull upstream dev

А дальше веточку от dev (Всегда проверяй, от какой ветки ты делаешь новую):

  • $ git checkout -b "[Название ветки]"

Для переключения между ними используй:

  • $ git checkout "[Название ветки]"

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

  • $ git status $ git diff --stat

Если в статистике изменённых строк слишком много - значит, ты сделал что-то не так.
Выполни $ git diff и проверь все свои изменения построчно.
Проверил? Никакого лишнего говна нет? Отлично, можно коммитить.

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

На всякий случай перед этим можно сделать git pull upstream dev, и если снова увидишь vi - можешь не вводить пояснений, это мерж-коммит.
Постарайся умещать одну фичу в один коммит. Не больше и не меньше.
/ Отлично, ты насрал своими коммитами. Время пропихнуть это в репу. Пропихиваем говно в репозиторий
Здесь всё куда проще. Открываешь страничку своего форка и жмешь кнопочку New Pull Request.
Нажал? Выбирай base-fork'ом ChaoticOnyx/OnyxBay, а head-fork'ом - свой форк.
Вкратце опиши, какие фичи (и баги) были добавлены. Создавай ПР. Поздравляю, ты успешен! Жди мержа. Или комментариев с гайдлайном по изменению кода в лучшую сторону.

Источник — https://wiki.ss13.ru/index.php?title=A_quick_guide_to_CONTRIBUTING&oldid=31107