Přeskočit obsah

Poskytování recenze žádosti o stažení

Vždy nás potěší recenze od přispěvatelů, bez ohledu na jejich úroveň zkušeností.

Proč hodnotit příspěvky?

Každý zaslaný příspěvek musí být zkontrolován, bez ohledu na to, zda jej zaslal člen hlavního týmu nebo nováček. Každý může něco přehlédnout. Proces kontroly slouží jako dodatečná pojistka.

Účelem procesu kontroly je zajistit, aby veškerý obsah, včetně kódu a dokumentace, byl co nejvíce bez chyb a snadno udržovatelný. Jakýkoli příspěvek, který pomůže dosáhnout tohoto cíle, je vítán. Může se jednat o něco tak jednoduchého, jako je oprava překlepu, až po nalezení okrajových případů v používání API, které nebyly zachyceny. Můžete identifikovat způsoby, jak by testovací režim mohl být robustnější, nebo navrhnout způsoby, jak strukturovat celkovou architekturu změn tak, aby byly snáze udržovatelné nebo rozšiřitelné.

Mohu to zkontrolovat?

Ano! Můžete nabídnout recenzi na jakýkoli pull request, který vidíte otevřený na BeeWare.

Jako nováček byste se neměli bát zkontrolovat jakýkoli pull request, který najdete, i když byl odeslán členem hlavního týmu. Jste-li nováčkem, možná vám uniká širší kontext projektu, ale naším cílem je, aby byl kód přístupný bez ohledu na vaši úroveň zkušeností. Pokud vám něco v kódu nedává smysl, může to znamenat, že je potřeba více dokumentace (buď v kódu, nebo jako samostatná dokumentace návrhu).

Přispění k revizi žádosti o stažení

Poskytování recenze žádosti o stažení

Každý je vítán, aby zkontroloval jakýkoli příspěvek k projektu BeeWare. Než začnete, je třeba si uvědomit několik důležitých věcí.

NEŽ NAPÍŠETE RECENZI, ROZMYSLETE SI TO

Než se pustíte do recenze, ZAMYSLETE SE. Jako recenzenti bychom měli zvážit, zda odpověď, kterou se chystáme odeslat, je:

  • Pravda. Vždy se snažte poskytovat přesné návrhy a informace.
  • Užitečné. Poskytujeme pokyny, jak zlepšit podání; tyto pokyny by měly jasně identifikovat zdroj problému nebo nezohledněný případ použití a v ideálním případě poskytnout návod, jak daný problém vyřešit nebo uspokojit dané obavy.
  • Inspirující. Je na nás, abychom autora inspirovali k tomu, aby provedl požadované změny.
  • Nezbytné. Očekává se, že autor si přečte vše, co zveřejníme; musíme respektovat jeho čas a úsilí a zveřejňovat pouze to, co je nezbytné.
  • Laskavost. Stejnou zpětnou vazbu lze vyjádřit mnoha způsoby; musíme se ujistit, že volíme laskavá, podpůrná a konstruktivní slova.

Je zcela možné MYSLET a zároveň poskytovat efektivní recenzi. Výše uvedené koncepty nevylučují poukazování na jakékoli problémy, které v PR najdete. Přispěvatelé nebudou mít příležitost zlepšit svůj příspěvek, pokud si nebudou vědomi oblastí, které je třeba zlepšit. Důležité je mít na paměti, jak tuto zpětnou vazbu prezentujete. Snažte se, aby vaše recenze byla neosobní. Místo „Udělal jste chybu“ můžete říci „Tento kód by mohl být vylepšen“. Recenzujte kód, ne autora.

Je důležité nezapomínat na pozitivní zpětnou vazbu, kromě identifikace oblastí, které je třeba zlepšit. Pokud jsou například změny obzvláště užitečné, dělají něco zvlášť chytrého nebo vám představí API, o kterém jste nevěděli, dejte to autorovi vědět! Nikdy nepodceňujte účinek poukázání na něco, co někdo udělal správně nebo dobře, uprostřed situace, kdy vše ostatní, na co jste poukázali, jsou problémy, které je třeba vyřešit.

Rozhraní GitHub pro revize obsahuje mechanismus pro navrhování změn, ve kterém můžete zadat přesnou změnu, kterou navrhujete jako náhradu za stávající obsah. Mějte na paměti, že dokud nebudou tyto navrhované změny přijaty a potvrzeny, nebudou procházet kontrolami před potvrzením a kontrolami linting. Proto by tato funkce měla být používána pro menší změny, protože čím větší je navrhovaná změna, tím větší je pravděpodobnost, že způsobí problémy.