Lekéréses kérelmek – MRTK2
Előfeltételek
Ha korábban még nem járult hozzá Microsoft-projekthez, előfordulhat, hogy a rendszer arra kéri, hogy írjon alá egy hozzájárulási licencszerződést. A pr megjegyzése tudatja Önvel, ha igen.
Fontos
Ha Ön Microsoft-alkalmazott, és nem tagja a Microsoft-szervezetnek a GitHubon, kapcsolja össze Microsoft- és GitHub-fiókjait a corpneten, mielőtt elindítja a lekéréses kérelmet, látogasson el a Microsoft Nyílt forráskódú szolgáltatásába. Van néhány folyamat, amit előre el kell végeznie.
Lekéréses kérelmek létrehozása
Ha készen áll egy lekéréses kérelem elküldésére, hozzon létre egy lekéréses kérelmet a fő ágra. A kiadásstabilizálási időszakban jelentkező hibajavításokért keresse meg a legújabb prerelease/* ágat. Az új funkcióknak mindig a következőbe kell lépnie main: .
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 hivatkozzon bármely problémára/ funkciókérésre vagy feladatra, amelyhez a lekérés kapcsolódik.
- 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 az összes nyilvános mező rendelkezik-e megjegyzésekkel.
- Ha új funkciót ad hozzá, ellenőrizze, hogy vannak-e tesztek a funkció ellenőrzéséhez (lásd: UnitTests).
- Hiba kijavítása esetén írjon egy tesztet a hibajavítás ellenőrzéséhez.
A projekt karbantartói áttekintik a módosításokat. Célunk, hogy az összes módosítást három munkanapon belül áttekintsük. Kérjük, vegye figyelembe a véleményezési megjegyzéseket, küldje el a témakörágat, és tegyen közzé egy megjegyzést, amely tudatja velünk, hogy új dolgokról van szó.
Megjegyzés
A projektbe beküldött pr-eket az MRTK kódolási szabványokkal kapcsolatos útmutatója is ellenőrzi, ezért kérjük, tekintse át ezeket, mielőtt beküldené a pr-t 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 PRS-eket gyorsabban és alaposabban felülvizsgálják, kevésbé valószínű, hogy hibákat vezetnek be, könnyebben visszaállíthatók és könnyebben egyesíthetők.
A lekéréses kérelmeknek elég kicsinek kell lenniük ahhoz, hogy egy mérnök 30 perc alatt áttekintse. Próbáljon meg minimális módosítást végezni, amely csak egy dolgot kezel. Ha létre kell hoznia egy nagy pr-t, ossza fel több olyan kérelemszolgáltatóra, amely a helyi ágba vagy az MRTK szolgáltatáságába kerül. Kerülje az új objektumok (pl. fbx, obj-fájlok) hozzáadását, és ehelyett a meglévő objektumok újbóli használatát célozza meg.
A teszteket ugyanabban a lekéréses kérelemben kell hozzáadni, mint a javítást / funkciót, kivéve a vészhelyzeteket
A tesztek a legjobb módja annak, hogy a módosítások ne lépjenek vissza a meglévő kódra, de a lekéréses kérelmek elküldésekor is könnyen elfelejthető a tesztek. Annak megkövetelése, hogy bemenjenek a pr-hez, nagyszerű módja annak, hogy a tesztek meg legyenek írva.
Minden funkcióhoz és hibajavításhoz teszteket kell társítani. Ha nincs tapasztalata vagy ideje a teszt írására, hozzon létre egy problémát a tesztek megírásához, és jelölje meg őket a Consider for Current Iteration címkével.
A dokumentációt ugyanabban a lekéréses kérelemben kell hozzáadni, mint egy javítást/ funkciót
A legtöbb fejlesztő először a dokumentációt vizsgálja meg, nem a kódot, amikor megismeri a funkció használatát. A dokumentáció naprakészségének biztosítása sokkal egyszerűbbé teszi a felhasználók számára az MRTK használatát és használatát. A dokumentációt mindig össze kell csomagolni a kapcsolódó lekéréssel, hogy az elemek naprakészek és konzisztensek maradjanak.
Győződjön meg arról, hogy minden nyilvános mező, metódus, tulajdonság három perjeles összesítő megjegyzést tartalmaz, hogy a docfx-webhelyünk leírásokat generálhasson 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érelmek leírásának egyértelműen és teljesen le kell írnia a módosításokat
A lekéréses kérelmek egyértelmű és teljes leírása biztosítja, hogy a felülvizsgálók megértsék, mit vizsgálnak.
Ha UX-t tartalmazó funkciókat ad hozzá, adjon hozzá egy képet /gif-et a módosított funkcióról. Íme egy jó példa. Egy másik javaslat, hogy legyen egy gif az Előtte és utána, például ebben a lekéréses kérelemben. A gifek képernyőrögzítésekből való létrehozásához ajánlott eszköz a ScreenToGif.