Žádosti o přijetí změn – MRTK2

Požadavky

Pokud jste do projektu Microsoftu ještě nepřispívali, můžete být požádáni o podepsání licenční smlouvy s příspěvkem. V případě potřeby vás o tom upozorní komentář v žádosti o přijetí změn.

Důležité

Pokud jste zaměstnancem Microsoftu a nejste členem organizace Microsoft na GitHubu, propojte své účty Microsoftu a GitHubu na corpnetu tak, že před zahájením žádosti o přijetí změn navštívíte Open Source v Microsoftu . Některé procesní věci budete muset udělat předem.

Vytvoření žádosti o přijetí změn

Až budete připraveni odeslat žádost o přijetí změn, vytvořte žádost o přijetí změn, která bude cílit na hlavní větev. Informace o opravách chyb během období stabilizace verze najdete v nejnovější prerelease/* větvi. Nové funkce by vždy měly být součástí main.

Přečtěte si pokyny a ujistěte se, že vaše žádost o přijetí změn splňuje pokyny.

• Nezapomeňte odkázat na jakýkoli problém nebo žádost o funkci nebo úlohu, ke které se žádost o přijetí změn vztahuje.
• Zkontrolujte, jestli žádost o přijetí změn obsahuje jenom soubory nebo změny související s žádostí o přijetí změn.
• Zkontrolujte, jestli je dokumentace aktuální a zahrnutá. Zkontrolujte, jestli všechna veřejná pole obsahují komentáře.
• Pokud přidáváte novou funkci, zkontrolujte, jestli jsou k ověření funkce zahrnuté testy (viz UnitTests).
• Pokud opravíte chybu, napište test, který ověří opravu chyby.

Správci projektu zkontrolují vaše změny. Cílem je zkontrolovat všechny změny do tří pracovních dnů. Vyřešte prosím všechny komentáře ke kontrole, nasdílejte je do větve svého tématu a publikujte komentář s informací, že je tu něco nového, co je potřeba zkontrolovat.

Poznámka

Všechny žádosti o přijetí změn odeslané do projektu budou také prověřeny podle průvodce standardy kódování MRTK, proto si je před odesláním žádosti o přijetí změn projděte, abyste zajistili hladký proces.

Pokyny k žádostem o přijetí změn

Tyto pokyny vycházejí z technických postupů Společnosti Google.

Zachování malých žádostí o přijetí změn

Menší žádosti o přijetí změn se kontrolují rychleji a důkladněji, jsou méně pravděpodobné, že zavádějí chyby, snadněji se vrací zpět a snadněji se sloučí.

Žádosti o přijetí změn by měly být dostatečně malé, aby je technik mohl zkontrolovat za méně než 30 minut. Pokuste se provést minimální změnu, která řeší jenom jednu věc. Pokud musíte vytvořit velkou žádost o přijetí změn, rozdělte ji do několika žádostí o přijetí změn, které přejdou buď do místní větve, nebo do větve funkcí MRTK. Vyhněte se přidávání nových prostředků (např. fbx, obj souborů) a místo toho se snažte znovu používat stávající prostředky.

Testy by se měly přidávat ve stejné žádosti o přijetí změn jako oprava nebo funkce, s výjimkou nouzových situací.

Testy představují nejlepší způsob, jak zajistit, aby změny neregrese stávajícího kódu, ale při odesílání žádostí o přijetí změn je také snadné na testy zapomenout. Vyžadování žádosti o přijetí změn je skvělý způsob, jak zajistit, aby se testy zapsaly.

Ke každé funkci a opravě chyb by se měly přidružit testy. Pokud nemáte zkušenosti nebo čas na napsání testu, vytvořte problém pro zápis testů a označte je popiskem Zvažte pro aktuální iteraci.

Dokumentace by měla být přidána do stejné žádosti o přijetí změn jako oprava nebo funkce.

Většina vývojářů se při pochopení toho, jak používat funkci, dívá nejprve na dokumentaci, ne na kód. Zajištění aktuelní dokumentace usnadňuje uživatelům používání a spoléhání se na sadu MRTK. Dokumentace by měla být vždy součástí souvisejícího vyžádání, aby položky zůstaly aktuální a konzistentní.

Ujistěte se, že každé veřejné pole, metoda a vlastnost má souhrnné komentáře s trojitým lomítkem , aby náš web docfx mohl generovat popisy polí nebo metod. V případě potřeby aktualizujte soubory Markdownu ve složce Dokumentace.

Popisy žádostí o přijetí změn by měly jasně a úplně popisovat změny.

Jasné a úplné popisy žádostí o přijetí změn zajistí, aby kontroloři pochopili, co kontrolují.

Pokud přidáváte funkce, které obsahují uživatelské prostředí, přidejte obrázek nebo gif funkce, kterou měníte. Tady je dobrý příklad. Dalším návrhem je mít v této žádosti o přijetí změn gif před a po. Nástroj, který doporučujeme pro generování gifů ze snímků obrazovky, je ScreenToGif.