Lekéréses kérelmek kezelése

Ez a cikk azt ismerteti, hogyan kezeljük a lekéréses kérelmeket az PowerShell-Docs-adattárban. Ez a cikk a PowerShell-Docs csapat tagjai számára készült. Itt tesszük közzé, hogy átlátható legyen a folyamat a nyilvános közreműködők számára.

Ajánlott eljárások

• A lekéréses kérelmet benyújtó személy nem egyesítheti a lekéréses kérelmet társértékelés nélkül.
• Rendelje hozzá a peer reviewert a lekéréses kérelem elküldésekor. A korai hozzárendelés lehetővé teszi, hogy a véleményező hamarabb válaszoljon szerkesztői megjegyzésekkel.
• Megjegyzések segítségével írja le a módosítás jellegét vagy a kért felülvizsgálat típusát. Győződjön meg róla, hogy @mention a véleményező. Ha például a módosítás kisebb, és nincs szüksége teljes technikai felülvizsgálatra, ezt egy megjegyzésben magyarázza el.

Lekéréses kérelem folyamatának lépései

1. Író: Lekéréses kérelem létrehozása
   • Csatolja a lekéréses kérelem által megoldott problémákat
   • A probléma megoldásához használja GitHub automatikus kizárási funkcióját
2. Író: Társ-véleményező hozzárendelése
3. Véleményező: korrektúra és megjegyzések (szükség esetén)
4. Író: Véleményezési visszajelzések beépítése
5. Mindkettő: Az előzetes verzió renderelésének áttekintése
6. Mindkettő: Ellenőrzési jelentés áttekintése – figyelmeztetések és hibák javítása
7. Író: Bejelentkezési megjegyzés hozzáadása (az Acrolinx-adatok belefoglalása)
8. Véleményező: "Jóváhagyva" megjelölése
9. Adattáradminisztrátor: Lekéréses kérelem egyesítése (a feltételekért lásd alább)

Tartalom véleményezői ellenőrzőlista

Átfogóbb listát a szerkesztői ellenőrzőlistán talál.

• Nyelvi ellenőrzés nyelvtanhoz, stílushoz, összefűzéshez, műszaki pontossághoz
• Győződjön meg arról, hogy a példák továbbra is érvényesek a célverzióra
• Előnézeti megjelenítés ellenőrzése
• Metaadatok ellenőrzése – ms.date, ms.assetid eltávolítása, kötelező mezők biztosítása
• Markdown helyességének ellenőrzése
  • Tartalomspecifikus formázási szabályok stíluskalauza
• A példák átrendezése az alábbiak szerint:
  • Bevezető mondat(ok)
  • Kód és kimenet
  • A kód részletes magyarázata (szükség szerint)
• A hivatkozások pontosságának ellenőrzése
  • TechNet-/MSDN-hivatkozások cseréje vagy eltávolítása
  • A cél felé irányuló átirányítások minimális számának biztosítása
  • HTTPS-kapcsolat biztosítása
  • Helyes hivatkozástípus
    • Helyi fájlok fájlhivatkozásai
    • A dokumentumkészleten kívüli fájlok URL-hivatkozásai
  • Területi beállítások eltávolítása URL-címekről
  • Az URL-címek egyszerűsödése docs.microsoft.com

Ágegyesítési folyamat

Az main ág az egyetlen olyan ág, amelybe liveegyesítve van. A rövid élettartamú (működő) ágak egyesítését össze kell nyomni.

Egyesítés innen/innen	kiadási ág	main	Élő
munkaág	squash és egyesítés	squash és egyesítés	Nem engedélyezett
kiadási ág	—	Egyesítése	Nem engedélyezett
main	újrabázis	—	Egyesítése

Pr Merger ellenőrzőlista

• A tartalom áttekintése befejeződött
• A módosítás célágának javítása
• Nincsenek egyesítési ütközések
• Minden ellenőrzési és összeállítási lépés sikeres
  • A figyelmeztetéseket és javaslatokat ki kell javítani (lásd a kivételek megjegyzéseit )
  • Nincsenek hibás hivatkozások
• Egyesítés táblázat szerint

Jegyzetek

A következő figyelmeztetések hagyhatók figyelmen kívül:

Can't find service name for `<version>/<modulepath>/About/About.md`

Metadata with following name(s) are not allowed to be set in Yaml header, or as file level
metadata in docfx.json, or as global metadata in docfx.json: `locale`. They are generated by
Docs platform, so the values set in these 3 places will be ignored. Please remove them from all
3 places to resolve the warning.

A lekéréses kérelem egyesítésekor a célág HEAD-e módosul. Az előző HEAD-en alapuló nyitott lekéréses kérelmek elavultak. Az elavult lekéréses kérelem rendszergazdai jogosultságokkal egyesíthető a GitHub egyesítési figyelmeztetéseinek felülbírálása érdekében. Ez akkor biztonságos, ha a korábban egyesített lekéréses kérelem(ek) nem nyúltak ugyanazokhoz a fájlokhoz. Az Ág frissítése gombra kattintva azonban a legbiztonságosabb lehetőség. Előfordulhat, hogy megoldatlan ütközéseket kell kijavítani.

Közzététel élőben

Az ágban main felhalmozódott módosításokat rendszeresen közzé kell tenni az élő webhelyen.

• Az main ág minden hétköznap 15:00-kor (PST) egyesül live .
• Az main ágat minden jelentős változás után egyesíteni live kell.
  • 50 vagy több fájl módosítása
  • Kiadási ág egyesítése után
  • Az adattár- vagy docsetkonfigurációk (docfx.json, OPS-konfigurációk, buildszkriptek stb.) módosítása
  • Az átirányítási fájl módosításai
  • A toc módosítása
  • A "projekt" ág egyesítése után (tartalomátcsoportosítás, tömeges frissítés stb.)