Lekéréses kérelmek

Előfeltételek

Ha korábban még nem járult hozzá Egy Microsoft-projekthez, a rendszer megkérheti, hogy írjon alá egy hozzájárulási licencszerződést. Ha ezt meghozta, a lekért megjegyzés tudatja.

Fontos

Ha Ön Microsoft-alkalmazott, és nem tagja a Microsoft-szervezetnek a GitHub-ben,a lekéréses kérelem elkezdését megelőzően csatolja a vállalati hálózatban található Microsoft- és GitHub-fiókokat a Microsoft nyílt forráskódú webhelyén. Van néhány folyamat, amit előre el kell tennem.

Lekéréses kérelmek létrehozása

Ha készen áll egy lekéréses kérelem elküldését, hozzon létre egy lekéréses kérelmet a főágra. A kiadási stabilizálási időszakban a hibajavításokért keresse meg a legújabb prerelease/* ágat. Az új funkcióknak mindig a (A) ába kell main bemenni.

Olvassa el az irányelveket, és győződjön meg arról, hogy a lekéréses kérelem megfelel az irányelveknek.

  • Mindenképpen hivatkozjon a lekéréses kérelemhez kapcsolódó bármely problémára/ funkcióra vagy feladatra.
  • Ellenőrizze, hogy a lekéréses kérelem csak a lekéréses kérelemhez kapcsolódó fájlokat/módosításokat tartalmazza-e.
  • Ellenőrizze, hogy a dokumentáció naprakész-e és szerepel-e benne. Ellenőrizze, hogy minden nyilvános mezőhöz fűznek-e megjegyzéseket.
  • Ha új funkciót ad hozzá, ellenőrizze, hogy a funkció ellenőrzésében szerepelnek-e tesztek (lásd: UnitTests).
  • Hibajavítás esetén írjon egy tesztet a hibajavítás ellenőrzéséhez.

A projekt karbantartók áttekintik a módosításokat. Három munkanapon belül szeretnénk áttekintni az összes módosítást. Kérjük, tekintse meg a felülvizsgálati megjegyzéseket, továbbkulálja a témakör ágát, és írjon egy megjegyzést, amely tudatja velünk, hogy új dolgokat kell áttekintenünk.

Megjegyzés

A projekthez beküldött összes leküldéses kérelem az MRTK kódolásiszabványokkal vonatkozó útmutatója szerint is ellenőrizve lesz, ezért kérjük, tekintse át ezeket, mielőtt beküldi a leküldéses kérelmet a zökkenőmentes folyamat érdekében.

Lekéréses kérelmekre vonatkozó irányelvek

Ezek az irányelvek a Google mérnöki gyakorlatán alapulnak.

A lekéréses kérelmek kis méretűek maradnak

A kisebb lekért lekért eljárásokat gyorsabban és alaposan felülvizsgálják, kevésbé valószínű, hogy hibákat vezetnek be, könnyebben vissza lehet vonni és egyszerűbben egyesíteni őket.

A lekéréses kérelmeknek elég kis méretűnek kell lennie ahhoz, hogy egy mérnök 30 perc alatt át tudja azt vizsgálni. Próbáljon meg minimális változtatást tenni, amely csak egy dologra elég. Ha létre kell hoznia egy nagyméretű le pr-t, ossza fel több lekértre, amelyek a helyi ágba vagy az MRTK egyik funkcióágába kerülnek. Kerülje az új adateszközök (például fbx, obj-fájlok) hozzáadását, és ehelyett a meglévő adateszközöket kell újra használni.

A teszteket ugyanabba a lehívásba kell hozzáadni, mint a javítást/funkciót, kivéve a játékokat

A tesztek a legjobbak annak biztosítására, hogy a módosítások ne regressziós kódot küldjenek vissza, de a lekéréses kérelmek elküldésekor könnyű megfeledkezni a tesztekről. Ha kötelezően be kell szereznie a lekért pr-t, azzal biztosíthatja, hogy a teszteket megírják.

Minden funkcióhoz és hibajavításhoz tesztnek kell társítva lennie. Ha nem rendelkezik a megfelelő szakértelmével vagy ideje egy teszt megírásához, hozzon létre egy problémát a tesztek megírásához, és jelölje meg őket címkével Fontolja meg az aktuális iterációt.

A dokumentációt ugyanabban a lekéréses kérelemben kell hozzáadni, mint a javítást/funkciót

A legtöbb fejlesztő a dokumentációt, és nem a kódot használja a funkciók használatának megértéséhez. A dokumentáció naprakészen hagyatkozásának biztosítása sokkal egyszerűbbé teszi a mrtk-k fogyasztását és a rá támaszkodó személyek számára. A dokumentációt mindig a kapcsolódó lekért adatokkal együtt kell csomagolni, hogy az elemek naprakészek és konzisztensek maradjanak.

Győződjön meg arról, hogy minden nyilvános mező, metódus és tulajdonság rendelkezik három perjeles összefoglaló megjegyzésekkel, hogy a docfx-webhely leírásokat hoz létre a mezőkhöz/metódusokhoz. Szükség esetén frissítse a Markdown-fájlokat a Dokumentáció mappában.

A lekéréses kérelem leírásának egyértelműen és teljes mértékben le kell írnia a változásokat

A lekéréses kérelmek világos és teljes leírása biztosítja, hogy a felülvizsgálók megértsék, mit felülvizsgálatát fognak végrehajtani.

Ha UX-t tartalmazó funkciókat ad hozzá, adjon hozzá egy képet/gif-et a módosított funkcióról. Példa a következőre:. Egy másik javaslat, hogy adhatja meg az Előtte és utána gif-et, például ebben a lekéréses kérelemben. A GIF-ek képernyőfelvételből való létrehozásához a ScreenToGif eszközt javasoljuk.