Как да направите първата си заявка притегляне, мястото на език за програмиране да ръждясат

Това ръководство ще ви научи как да се направят промени в проекта на GitHub. Процесът, описан тук, предлага най-добрата практика е често срещано явление - можете да го използвате извън нашата общност. В общинските проекти да се придържат към този процес е силно препоръчително.

На първо място, ние ще дадем описание на високо ниво на процеса, а след това се опише по-подробно всяка стъпка.

Предполага се, познаване на основите на система за контрол на версиите Git. Ако не сте работили с Git, даваме връзки към официалната документация на руски език за необходимите команди.

Тук е процес, с изглед от птичи поглед.

1. Forknite проект.
2. Skloniruyte хранилище.
3. Създаване на клон за неговата работа.
4. Направете необходимите промени в файлове - код, документация, за изпитване. ги Zakommitte към новосъздадения клон.
5. Уверете се, че проектът работи след промените.
6. Направи издърпване Заявка.
7. Обсъдете с рецензент по време на прегледа на код. Ако е необходимо, да направи промени в издърпване на заявката.
8. Когато всички са щастливи, Издърпайте Заявка за вземане - от този момент вашите промени са в оригиналната хранилището (нагоре) и са част от проекта.

Работата по задачата е завършена!

Сега гледам на всяка стъпка в детайли.

forkan проект

Не можете да изпращате ангажира (Git тласък) направо в изходния хранилището. По искане на собственика на проекта може да го позволи, но обикновено пишат достъпът е само за хора, които подкрепят проекта, както и всяка друга работа, чрез издърпване Request'y ( "искания за промени инфузионни"; за тях - по-долу).

В един момент ще бъдете пренасочени към страницата на вилицата.

клонинг хранилище

След това е необходимо да се клонира хранилището на локалния ви машина. За да направите това ние се нуждаем от хранилище URL адрес. При кликване върху бутона вдясно, можете да го копирате в клипборда. Обърнете внимание на лявата страна на избрания протокол. Ако не сте конфигурирали SSH да GitHub, там трябва да бъдат посочени HTTPS.

След изпълнение на командата в терминала (или командния ред Windows):

Git клонинг <вставляем_URL>

Skloniruetsya хранилище в поддиректория на текущата директория. Например, ако едно хранилище, наречено Foobar. ще имате директория Foobar.

създаване на нишка

подразбиране клон - господар. За да промените по-лесно да управляват и те да не се смесват един с друг, създаване на отделен клон, където той ще работи. В този случай, на клона трябва да се нарича така, че името говори за нейното назначаване.

Например, ние искаме да се коригира грешка в протокола за изпълнение PROTOBAZ. така, че нашият клон се нарича корекция-protobaz.

Сега стигаме до нашата писта хранилище и създаване на клон:

Тази команда трябва да се помни - когато вие не знаете състоянието на хранилището, просто го направи. Предимно в своите изход Git покажи другите отбори, които правят това, което ти си (най-вероятно) и искате да направите.

Правим промени

Сега започваме да работим. Редактирайте кода актуализирайте документацията, ние се определи тест за допълване на README.

Тези промени ще се ангажира в нашия бранш. Как да го направя - по-долу.

В същото време, опитайте се да направите често се ангажират и да се ангажират - малък по обем. Всеки се ангажират да правят точно едно нещо, и в същото време да се запази здравето на проекта. Ние трябва да се стремим да се гарантира, че можете да отидете и да е ангажимент и да получите работен проект за в бъдеще.

Ако просто не се получи да се придържаме към такава дисциплина, или промени се отразяват на целия проект, "чрез", е допустимо да се прекъсне проекта и постепенно го поправим в следващите ангажират.

Ако вече сте запознат с Git, тогава ще трябва да се съчетаят тези не-атомни изменения в един ангажират с помощта на интерактивна rebase и скуош.

Така че, след редактирането на файла, ние имаме следната ситуация (този статут заключение Git):

От всички части на съобщението, само първата е задължително.

То трябва да има формата <Глагол в настоящем времени, первом лице, множественном числе> <объект изменения>. Става дума за това, което правим в този ангажират: [ние] корекции на грешки, [ние] добавяне на възможности, [ние] Актуализираме документация.

Последният ред - е екип от GitHub. Когато се ангажират с такъв отбор получава за овладяване. GitHub автоматично ще се затвори специфичната задача. Можете да използвате различни форми на тази команда: Fix # 123. определя # 123. близо 123 # и др. Това спестява време за подкрепа на проекта.

В нашите проекти, трябва да се използва Fix # 123 или 123 Затвори # на последния ред се ангажира съобщение.

Git влезете --oneline показва историята във формат "1 коментара -. 1 линия на екрана" В същото време той използва като описание на първия ред на извършване на - кратко описание. Ето защо, тя трябва задължително да се разделят с един празен ред от останалата част на описанието - или единично разпръснати за оттегляне.

Език на съобщението за извършване трябва да съответства на приетия език на проекта. Тъй като нашите проекти са насочени към публиката рускоговорящи разработчиците твърдят, че на руски, съобщението се ангажират също трябва да бъде на руски.

проверявате промените

Когато сте готови за редактиране, е необходимо да ги изпробвате - освен ако не е нещо абсолютно незначителен.

За да направите това, трябва да се изгради по проекта и изпълнете тестовете, ако има такива. Във всеки случай е необходимо да се тестват кода, който сте написали или променени чрез стартиране на програма или като се обадите на библиотеката.

Ако проектът - статично генерирани сайт, вие трябва да го генерира локално и се уверете, че нищо не е паднал и оформлението не е се разделиха. Ако книгата - едно и също нещо. Потърсете най-малко тези места, че си прав.

Създаване на издърпване Искане

Когато работата е завършена и се проверява, че е време да се създаде издърпване Заявка. Издърпайте Заявка - искане за вливане на вашия клон промени в изходния хранилището основните линии. По този начин те попадат на собствениците на проекта.

За да създадете издърпване Искане, zaydom със страница на вилицата. Още от падащото меню с възможност за избор на клон има «Нова молба за дърпане» бутон.

Ще намерите себе си в прозорец на сравнение на клон.

Това са елементите на този прозорец, за:

След натискане на бутона, екран за въвеждане издърпване Заявка съобщението.

Мнение PR - е описание на това, което е направено и защо. За разлика от съобщението за извършване тук вече трябва да напишете описание на високо ниво от това, което са направени промени. Като част от "защо", както и форматът на съобщението - необходимо е да се придържат към същите правила, както в случая на ангажира. Кратко хедър (дял), в коментар - описание, след което информацията за обслужване (Fix # 100500). Ако пише екипът се ангажира със затварянето на задачите, не можете да ги дублира. Ако не - пишете тук.

След това кликнете върху «Създаване на притегляне поискване». Той е създаден, той идва до знанието на хората, които подкрепят проекта, и тя става видима в източник хранилището на «Pull исканията» раздела. прегледа на промените (преглед на кода) започва от този момент.

Съвет: ако веднага след като изпратите вашето хранилище клон (Git тласък произход) отидете на страницата на хранилището, има предложение да се създаде издърпване Искане на клона на инфузия неотдавна изпрати на капитана. Можете да направите това в Fork и в оригиналната хранилището. Това ще бъде отделен бутон в горната част, а когато тя е натиснат като клон на сливането ще се уточни, че когато правиш Git тласък.

Ние участваме в Проверка на код

На този етап, хората, които подкрепят проекта, гледат на вас Издърпайте Заявка направена и го обсъдя с вас. Може би някои неща ще трябва да се коригира, да се подобри или да завърши в процеса на преглед - това е нищо необичайно, а това не означава, че си лоша работа.

В нашето общество ние не са направени, за да се сблъскате с начинаещи, и ние винаги се опитваме да помогнем. Да не се обезсърчават от прегледа - написано по-горе много думи, но в действителност просто задоволително, за да се държат, а не да чука на корекции.

Когато този етап е завършен, рецензент кликне върху бутона «Merge издърпване Заявка». Вашите промени бяха въведени у главният източник на проекта.

Честито! Вече сте пълноправен участник в проекта.

изключване

След вливане на PR трябва да се внесе ред в хранилището. Ако вашите промени са самодостатъчни след PR не е длъжна да продължи да работи за, трябва да премахне бранша. Както си спомняте, ние го създадохме по-рано, за да направи по-лесно да се справят с промените.

Но най-напред е по-добре да обновите вашия местен майстор-клон - тогава Git да се уверите, че вашият бранш вече е излята в господар. и няма да ви предупредя, че може да загубите промените.

Така че, ние актуализираме местната работна копие. За да направите това, добавете друго дистанционно - така нареченият дистанционно хранилище. Сега можете да го имате само един - произход. и той насочва към вилицата. Добави дистанционно име нагоре. който ще посочи източник хранилището:

Сега имаме чиста, актуализиран хранилище. Можете да започнете работа по нов PR.

Ако имате нещо не е направено или писмено не е ясно - пише за него в чата или да създаде проблеми в нашето хранилище.

Ако в даден момент има грешки - правя статус Git. Много често Git подсказва и самото това, което може да се направи и как да го направя. Ако все още не работи - моля свържете се с чата може да помогне.

Тези въпроси могат да бъдат решени в чата, и за в бъдеще ще се опитаме да се напише наръчник и по тези теми.

Добра да се ангажират, дори ако проектът се случва и изпитанията преминат. Изпратете Request'y Издърпайте!

Поддръжка на Patreon