Lekéréses kérelmek

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. Ha megjegyzése van a lekért pr-hez, akkor tud róla, ha igen.

Fontos

Ha Ön Microsoft-alkalmazott, és nem tagja a Microsoft-szervezetnek a GitHub-on,akkor a lekéréses kérelem elkezdését megelőzően a Microsoft nyílt forráskódját megnyitva csatolja a vállalati hálózat microsoftos és GitHub-fiókjait. Van néhány folyamat, amit előre el kell látnia.

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 elérhető hibajavításokért keresse meg a legújabb prerelease/* ágat. Az új funkcióknak mindig a(nak) nek kell main lennie.

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 hivatkozni kell minden olyan problémára/funkcióra, amelyhez a lekéréses kérelem 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 minden nyilvános mezőhöz vannak-e megjegyzések.
  • Ha új funkciót ad hozzá, ellenőrizze, hogy szerepelnek-e tesztek a funkció ellenőrzésében (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. Célja, hogy az összes módosítást három munkanapon belül áttekintsünk. 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 elküldött összes leküldéses kérelem az MRTKkódolási szabványokkal való ú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 LE-ket gyorsabban és alaposan felülvizsgálják, kisebb valószínűséggel vezetnek be hibákat, könnyebb a visszaállítás és az egyesítés.

A lekéréses kérelmeknek elég kis méretűnek kell lennie ahhoz, hogy egy mérnök 30 perc alatt áttekinthúzhatja. Próbáljon meg egy minimális változtatást, amely csak egy dologra van hatással. Ha létre kell hoznia egy nagyméretű le pr-t, ossza fel több lefuttatási pontra, amelyek a helyi ágba vagy az MRTK egy 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 törekedj a meglévő adateszközök újrahasználatra.

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

A tesztek a legjobb módszer 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 a lekért pr-t kötelezően be kell szereznie, 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, amikor a funkciók használatát érti. A dokumentáció naprakészen hagyatkozása megkönnyíti az MRTK-k fogyasztását és támaszkodását. 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őhöz, metódushoz és tulajdonsághoz három perjeles összegző megjegyzések vannak, hogy a docfx webhely leírásokat hoz létre a mezőkhöz/metódusokhoz. Ha szükséges, 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 a felhasználói felületet 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 egy "Előtte és Utána" gif-fájl legyen, 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.