Zpráva o chybě Slack do opravy GitHub

Popište chybu jednoduchým jazykem v Slack. Okou napíše problém GitHub a přiřadí ho, a když příčina spočívá v jedné komponentě, otevře pull request s opravou a regresním testem, abyste ho mohli zkontrolovat.

Okou se připojuje:SlackGitHubLinear

Co Okou dodává: od zprávy Slack po opravu v revizi

Skutečné vlákno z kanálu #bug-report týmu Okou, zachycené tak, jak se stalo. Spolupracovník vložil zprávu zákazníka a požádal o opravu. O čtyři minuty později Okou podal problém GitHub s diagnózou. Čtrnáct minut po první zprávě otevřel pull request a zveřejnil odkaz na náhled. Níže jsou oba záznamy: vlákno, ve kterém to začalo, a pull request, který Okou napsal. Jsou veřejné, takže si můžete sami přečíst problém, rozdíl a recenzi.

Okou · Slack vlákno k pull requestuSkutečný běh

Co se stalo v konverzaci

Spolupracovník nahlásil chybu rozložení PWA zákazníka v #bug-report a přiložil snímky obrazovky. Okou přečetl vlákno, vystopoval ji k hornímu panelu vykreslenému bez odsazení bezpečné oblasti iOS a podal problém #11708 s popisky a svým zdůvodněním. Když vlákno požádalo o opravu, Okou změnil jeden soubor (minimální výšku a odsazení bezpečné oblasti na mobilním horním panelu), otevřel žádost o stažení #11709 s odkazem na náhled a tam se zastavil. Osoba ji zkontrolovala a sloučila.

Zpráva k podanému problému
4 minproblém #11708, označený jako chyba a PWA
Zpráva k žádosti o stažení
14 minPR #11709 s odkazem na náhled
Soubory změněné opravou
1sloučeno osobou, nikoli Okou
Otevřít pull request #11709 na GitHub

Co znamená vytvořit problém GitHub z Slack?

Vytvoření problému GitHub z Slack znamená přeměnu chyby, kterou někdo popsal v konverzaci, na řádně strukturovaný problém ve vašem repozitáři, aniž by kdokoli opustil vlákno, aby ji přepsal. Nejtěžší částí nikdy nebylo volání API; je to napsání jasného názvu, oddělení kroků k reprodukci od očekávaného chování, výběr štítků, nastavení priority a nalezení správného vlastníka. Okou tuto práci dělá. Přečte zprávu Slack a odpovědi kolem ní, napíše tělo problému, aplikuje štítky a prioritu, kterou může odůvodnit, vyřeší přiřazeného uživatele porovnáním zobrazovaného jména Slack s handlem GitHub a zveřejní odkaz na problém zpět ve stejném vlákně, aby si ho reportér mohl na první pohled zkontrolovat.

Proč zprávy o chybách umírají ve vláknech Slack

Někdo si všimne chyby během ukázky, nebo zákazník napíše v sobotu. Stará cesta je dlouhá: otevřít GitHub, najít repozitář, napsat formátovaný problém, někomu ho přidělit, pak čekat, až si ho ta osoba vezme, přečte kód a napíše opravu. Desetiminutová změna se promění v několikadenní cestu tam a zpět mezi třemi lidmi a polovina zpráv se nikdy nedostane z vlákna. Místo toho to popíšete v Slack. Okou podá problém s kroky k reprodukci, štítky a vlastníkem, a pokud je příčina obsažena, pokračuje a otevře žádost o stažení s opravou a testem. Vy zkontrolujete a odešlete.

Jak Okou vytváří problém GitHub z Slack

Krok 1: Připojte své nástroje

GitHub
GitHub
Povinné
Připojení OAuth k GitHub. Okou potřebuje přístup pro čtení/zápis k vytváření problémů a, když má opravu, k odeslání větve a otevření žádosti o stažení.
Připojit
Slack
Slack
Povinné
Okou přečte vaši zprávu a odpoví ve stejném vlákně.
Připojit

Krok 2: Zeptat se Okou

Okou vytvořit problém: stisknutí ESC v dialogu plánování jej okamžitě zavře i s neuloženými úpravami. Mělo by se nejprve zeptat na potvrzení. Přiřadit Lancy. Označit jako chybu, platformu. Priorita střední.
Okou čte vlákno
Okou čte vaši zprávu a odpovědi kolem ní, takže kontext, který dorazil o tři zprávy později, se stále počítá. Identifikuje příjemce a odvozuje štítky a prioritu z toho, co lidé skutečně řekli.
Problém je nahlášen na GitHub
Napsaný název, popis, kroky k reprodukci oddělené od očekávaného chování, ovlivněná oblast, štítky a vlastník odpovídající zobrazovanému jménu Slack. Okou nejprve zkontroluje otevřené problémy a komentuje duplikát namísto podání druhého.
Okou najde příčinu a otevře pull request
Když vlákno nebo kód ukazuje na jednu komponentu a lze nejprve napsat selhávající test, Okou napíše opravu a tento test, propojí pull request s problémem a nechá běžet CI. Když to nelze, zastaví se u problému a ve vlákně uvede proč.
Vy zkontrolujete a odešlete
Okou odpoví ve stejném vlákně s problémem, žádostí o stažení a odkazem na náhled a požádá o kontrolu vlastníka. Nic se nesloučí samo; oprava čeká na vás.

Krok 3: Jděte dál

Požádat o opravu
Jděte za tiket k pull requestu
Okou opravte #6260 a otevřete PR s regresním testem. Propojte jej s problémem a zveřejněte odkaz na náhled v tomto vlákně.
Přidat více detailů
Připojte snímky obrazovky nebo kroky k reprodukci
Okou přidejte k #6260: kroky k reprodukci. 1. Otevřete dialog plánování 2. Napište něco 3. Stiskněte ESC. Očekáváno: potvrzovací dialog.
Problémy s dávkovými soubory
Vytvořte více problémů najednou
Okou vytvořte 3 problémy z těchto chyb: 1. Zavření dialogu ESC (Lancy) 2. Výběr data o jeden den mimo (James) 3. Nahrávání avatara selže v Safari (Yuma)
Automatizovat třídění
Automatické vytváření problémů z kanálu
Okou sledujte #bugs, když někdo zveřejní zprávu začínající „bug:“, automaticky vytvořte problém GitHub a odpovězte odkazem.

Integrace Slack a GitHub za pracovním postupem

Toto je integrace Slack GitHub s agentem uprostřed: Okou čte konverzaci v Slack a zapisuje záznam v GitHub. Každý konektor je udělen samostatně a je omezen na to, co pracovní postup skutečně používá, takže čtení kanálu nikdy neznamená přístup k zápisu do vašich repozitářů.

Slack

Integrace Slack: konverzace, kterou čte Okou

Povinné

Okou přečte zprávu, na kterou ho nasměrujete, a odpovědi kolem ní, takže kontext, který dorazil o tři zprávy později, se stále dostane do problému. Zachytí připojené snímky obrazovky a přenese je, přečte zobrazované jméno reportéra, aby vyřešil přiřazení, a zachová trvalý odkaz na zprávu, takže každý problém odkazuje zpět na místo, kde zpráva začala. Psaní je jen jedna věc: odpověď ve stejném vlákně s číslem problému a odkazem. Okou nezveřejňuje příspěvky na jiné kanály, neposílá DM ani neupravuje zprávy nikoho jiného.

GitHub

Integrace GitHub: problémy, které Okou zaznamenává

Povinné

Okou vytvoří problém v repozitáři, který určíte, s názvem napsaným ze zprávy spíše než kopií původní zprávy, popisem, kroky k reprodukci, očekávaným chováním a dotčenou oblastí, pokud ji vlákno pojmenuje. Použije štítky, které zadáte, nebo je odvodí z formulace, nastaví prioritu, kterou vysvětlí, a přiřadí vlastníka. Před podáním prohledá otevřené problémy pro stejný symptom a místo toho komentuje existující, pokud najde shodu. Pokud dokáže chybu také opravit, odešle větev a otevře požadavek na sloučení, který problém uzavře a požádá o kontrolu. Přístup pro zápis je omezen na repozitáře, které udělíte, a to je celá plocha: problémy, komentáře a požadavky na sloučení otevřené k revizi. Okou neslučuje, nevynucuje push ani se nedotýká nastavení repozitáře.

Okou vs. aplikace GitHub pro Slack vs. tvůrce automatizace

Dostání chyby ze zprávy Slack do GitHub má tři části: zachycení zprávy, napsání použitelného problému a jeho směrování k vlastníkovi. Stávající možnosti řeší každou z nich.

Aplikace GitHub pro Slack

Zadáním /github se otevře dialog, kde sami vyplníte název, tělo, štítky a přiřazeného. Ušetří to cestu do prohlížeče, ale stále jste to vy, kdo píše problém, a formulář uprostřed konverzace je přesně to tření, kvůli kterému lidé říkají „Podám to později.“

Tvůrce automatizace

Tvůrce bez kódu může zkopírovat zprávu Slack do nového problému na základě spouštěče. Kopíruje se surová zpráva, takže problém zdědí cokoli, co reportér náhodou napsal, a pravidla pro štítky, prioritu, přiřazení a duplikáty jsou ta, která musíte definovat a udržovat pro každý kanál.

Pracovní postup Okou Slack-to-GitHub

Okou přečte vlákno a napíše problém: skutečný název, kroky k reprodukci oddělené od očekávaného chování, štítky a prioritu, kterou může zdůvodnit, a přiřazeného řešitele odpovídajícího zobrazovanému jménu reportéra. Když je příčina omezena na jednu komponentu, pokračuje a otevře pull request s opravou a regresním testem, propojený s problémem a čekající na vaši revizi. Nejprve zkontroluje otevřené problémy a komentuje duplikát místo podání nového, a odpoví ve vlákně s odkazem.

Tipy pro lepší výsledky

Zahrňte jméno příjemce. Okou porovnává zobrazovaná jména Slack s uživatelskými jmény GitHub.
Pokud chcete konkrétní štítky, uveďte je explicitně, jinak Okou odvodí z kontextu.
Funguje i pro požadavky na funkce, stačí říct „požadavek na funkci“ místo „chyba“.
Řekněte „a otevřete PR“, když chcete opravu, ne jen lístek. Okou vám v vlákně řekne, zda je příčina příliš rozšířená na to, aby se dala bezpečně změnit.

Často kladené otázky

Jak vytvoříte problém GitHub ze zprávy Slack?

Připojte Slack a GitHub k Okou, poté popište chybu v kanálu a zmiňte Okou. Přečte zprávu a okolní odpovědi, napíše problém s názvem, kroky k reprodukci, očekávaným chováním, štítky a prioritou, vytvoří jej v pojmenovaném úložišti, přiřadí vlastníka a odpoví ve vlákně s číslem problému a odkazem. Nevyplňujete formulář.

V čem se to liší od aplikace GitHub pro Slack?

Aplikace GitHub vám poskytne dialog k vyplnění: stále píšete název, tělo, štítky a přiřazeného. Okou je píše z konverzace, před podáním kontroluje existující problém se stejným symptomem a může běžet napříč celým kanálem podle plánu, nikoli jednu zprávu po druhé.

Okou jen podá problém, nebo dokáže chybu opravit?

Obojí, a řekne vám, co udělal a proč. Okou vždy podá problém. Když vlákno nebo kód ukazuje na jednu komponentu, očekávané chování je jednoznačné a selhávající test lze napsat jako první, otevře také pull request s opravou a tímto testem, propojí ho s problémem a požádá o revizi. Sdílené utility, designové tokeny a cokoli, co vyžaduje produktové rozhodnutí, jsou podány, nikoli změněny. Okou nikdy neslučuje; každá oprava dorazí jako pull request, který zkontrolujete.

Může Okou automaticky přiřadit problém správné osobě?

Ano. Okou porovná jméno, které zmíníte, nebo zobrazované jméno reportéra Slack, s uživatelskými jmény GitHub v repozitáři a přiřadí problém. Pojmenování příjemce ve vaší zprávě je nejspolehlivější cesta; pokud nikdo není jmenován, Okou se vrátí k vlastníkovi oblasti, na kterou vlákno ukazuje, a v problému uvede, jak se rozhodl.

Jak se Okou vyhýbá podávání duplicitních problémů GitHub?

Před vytvořením čehokoli Okou prohledá otevřené problémy pro stejný symptom, postiženou oblast a formulaci. Když najde shodu, přidá nové vlákno Slack jako komentář k tomuto problému, s reportérem a časovým razítkem, a odpoví v Slack s existujícím odkazem na problém namísto otevření druhého.

Co se stane, když zpráva o chybě nemá kroky k reprodukci?

Okou stále podá problém, aby se zpráva neztratila, označí jej jako vyžadující kroky k reprodukci a odpoví ve vlákně Slack s žádostí o ně od reportéra. Odpověď pak přistane ve vlákně, které je již propojeno z problému.

Může Okou podávat chyby z celého kanálu podle plánu?

Ano. Nasměrujte Okou na jeden nebo více kanálů a dejte mu plán, například každý pátek v 16:00. Přečte zprávy z týdne, založí problém pro každou, která popisuje vadu, komentuje duplikáty, přeskočí požadavky na funkce a otázky a nahlásí, co udělal.

Funguje to s Linear nebo Jira místo GitHub?

Stejný tvar pracovního postupu platí pro jakýkoli tracker, ke kterému je Okou připojen; tato stránka pokrývá cestu GitHub, která používá konektor GitHub. Linear je připojen stejným způsobem a název trackeru uvedete v instrukci.

Zaznamenejte svou další chybu, aniž byste opustili Slack

Připojte Slack a GitHub, popište chybu tak, jak byste ji popsali kolegovi, a nechte Okou napsat problém a přiřadit ho. Když je příčina omezena, čeká na vás i pull request.

Okou vytvořit problém: stisknutí ESC v dialogu plánování jej okamžitě zavře i s neuloženými úpravami. Mělo by se nejprve zeptat na potvrzení. Přiřadit Lancy. Označit jako chybu, platformu. Priorita střední.