Začínáme s úkoly na GitHubu

  • 8 min

GitHub Issues je integrovaný systém pro sledování úkolů, chyb a žádostí o funkce v úložištích GitHubu. Než budete moct efektivně vyřešit problémy pomocí GitHub Copilotu, musíte porozumět tomu, jak efektivně pracovat s problémy GitHubu.

Co jsou problémy s GitHubem?

GitHub Issues poskytují pracovní prostor pro spolupráci, kde týmy sledují pracovní položky, dokumentují problémy a plánují vylepšení. Každý problém funguje jako lístek v sledovacím systému – může být přiřazen členům týmu, kategorizován s popisky, propojen s změnami kódu a rozšířen o diskuze a dokumentaci.

S nástrojem GitHub Issues si můžete představit seznam inteligentních úkolů týmu. Každá položka obsahuje diskuze, odkazy na kód a metadata, aby se zajistilo, že práce nezůstane opomenuta. V případě práce zaměřené na zabezpečení poskytuje problémy GitHubu viditelnost a sledovatelnost, která týmům pomáhá systematicky reagovat na ohrožení zabezpečení.

Základní komponenty problému

Porozumění struktuře problémů GitHubu vám pomůže efektivně číst, spravovat a řešit je.

Title

Název by měl být stručný a popisný souhrn problému. Dobré názvy pomáhají členům týmu rychle pochopit problém na první pohled.

Příklady efektivních názvů problémů:

  • Zranitelnost SQL injekce v endpointu vyhledávání produktů
  • "Slabé šifrování v úložišti hesel uživatele"
  • "Riziko procházení cesty při nahrávání souborů"

Dobře napsaný název okamžitě komunikuje s typem problému (ohrožení zabezpečení) i jeho umístěním (koncový bod vyhledávání produktů).

Description

Popis je místo, kde se nacházejí podrobnosti. Podrobný popis problému by měl obsahovat následující informace:

  • Co se děje: Jasné vysvětlení problému nebo požadavku
  • Kroky k reprodukci: V případě chyb se jedná o konkrétní akce, které problém aktivují.
  • Očekávané chování: Co by se mělo místo toho stát?
  • Proč je důležité: Důležitost řešení tohoto problému.
  • Kritéria přijetí: Jak ověřit, kdy se problém vyřeší.

Tady je příklad dobře strukturovaného popisu problému se zabezpečením:

The login authentication function stores user passwords in plaintext in the database.

**Current behavior:**
Passwords are stored directly as strings without hashing or encryption.

**Security impact:**
If the database is compromised, all user passwords are immediately exposed.

**Expected behavior:**
Passwords should be hashed using a secure algorithm (like bcrypt) with appropriate salt before storage.

**Acceptance criteria:**
- Implement bcrypt password hashing.
- Verify no plaintext passwords exist in storage.
- Update authentication to validate against hashed passwords.

Dobře napsaný problém je napůl vyřešen. Vede vývojáře přímo k problému bez nejednoznačnosti.

Comments

Oddíl komentáře umožňuje týmové diskuze. Členové týmu můžou:

  • Ptejte se na objasnění otázek.
  • Navržení potenciálních řešení
  • Sdílejte zjištění šetření.
  • Odkazujte na související kód nebo problémy.
  • Zdokumentovat rozhodnutí učiněná během řešení.

Komentáře vytvářejí znalostní stopu, která pomáhá aktuálním i budoucím vývojářům pochopit problém i důvod řešení.

Přiřazování

Přiřazený je osoba odpovědná za vyřešení problému. Mít jasného vlastníka zajišťuje odpovědnost a brání problémům ve stagnaci v backlogu.

Osvědčený postup: Vždy určete pro problém jednoho primárního vlastníka. Pokud jste zodpovědnou osobou, jste zodpovědní za vedení procesu k jeho vyřešení. Když jste přiřazeni, neznamená to, že pracujete samostatně – můžete spolupracovat s ostatními, ale nesete zodpovědnost za výsledek.

Štítky

Popisky kategorizují a upřednostňují problémy. Mezi běžné popisky patří:

  • Popisky typů: chyba, vylepšení, dokumentace, zabezpečení.
  • Prioritní popisky: P0-kritická, P1-vysoká, P2-střední, P3-nízká.
  • Popisky stavu: probíhá, blokováno, k revizi.
  • Popisky komponent: back-end, front-end, rozhraní API, databáze.

Popisky se dají použít k filtrování a řazení problémů v seznamech, což usnadňuje zaměření na práci související s vysokou prioritou nebo zabezpečením.

V případě problémů se zabezpečením popisky pomáhají týmům rychle filtrovat a určovat prioritu ohrožení zabezpečení, která vyžadují okamžitou pozornost. Popisek zabezpečení v kombinaci s P0-kritické signalizuje, že problém vyžaduje okamžitou akci.

Milníky

Milníky seskupují související úkoly směrem ke společnému cíli. Například uvedení verze nebo fáze projektu. I když nejsou důležité pro řešení jednotlivých problémů, milníky pomáhají týmům koordinovat práci a sledovat pokrok směrem k větším cílům.

Prozkoumání životního cyklu problému

Problémy procházejí několika fázemi od vytvoření až po vyřešení. Porozumění tomuto životnímu cyklu pomáhá efektivně spravovat problémy.

Fáze 1: Vytvoření

Problémy můžou vytvářet vývojáři, testeři nebo uživatelé, kteří identifikují problémy nebo příležitosti ke zlepšení. K problémům se zabezpečením může dojít prostřednictvím:

  • Revize kódu
  • Automatizované kontroly zabezpečení.
  • Penetrační testování.
  • Sestavy uživatelů
  • Audity zabezpečení

Při vytváření problému uveďte dostatečná kontextová a akceptační kritéria. Tím se stanoví jasná očekávání pro situaci, kdy se problém považuje za vyřešený.

Fáze 2: Třídění

Během třídění, vedoucí týmu nebo určená osoba:

  • Zkontroluje nové záležitosti.
  • Přiřadí úrovně priority.
  • Přidá odpovídající štítky.
  • Přiřadí problém vývojáři.
  • Odkazy související problémy nebo dokumentace

Problémy s vysokou závažností, zejména ohrožení zabezpečení, jsou označeny pro okamžité řešení. Problémy se zabezpečením by neměly nikdy zůstat v backlogu bez posouzení.

Fáze 3: Šetření a diskuze

Přiřazený vývojář problém prošetří. Vývojáři můžou během vyšetřování dokončit jednu nebo více následujících úloh:

  • Pokládání objasňujících otázek v komentářích
  • Zdokumentovat závěry z analýzy kódu
  • Navržení potenciálních řešení
  • Požádejte o další informace.
  • Identifikujte související oblasti kódu, kterých se to týká.

Tato fáze diskuze zajistí, aby všichni pochopili problém před implementací opravy.

Fáze 4: Implementace

Vývojář vytvoří větev funkcí a implementuje opravu. Proces implementace obvykle zahrnuje následující úlohy:

  • Psaní nebo úpravy kódu
  • Přidání nebo aktualizace testů
  • Místní ověření opravy
  • Příprava pull requestu (PR).

Fáze 5: Propojení commitů a pull requestů

GitHub automaticky připojí problémy ke změnám kódu, když na ně odkazujete v potvrzovacích zprávách nebo popisech žádostí o přijetí změn pomocí klíčových slov:

  • Fixes #123
  • Closes #123
  • Resolves #123

Příklad potvrzovací zprávy:

Fix SQL injection vulnerability in search function

Implement parameterized queries to prevent SQL injection attacks.
Add input validation for search parameters.

Fixes #42

Použití klíčových slov k odkazování na problémy vytváří sledovatelnost mezi problémem a jeho řešením. Po sloučení pull requestu GitHub automaticky zavře odkazovaný issue. Tato automatizace zajišťuje, že problémy nezůstávají otevřené poté, co jsou vyřešeny, a vytváří trvalé propojení mezi popisem problému a změnami v kódu, které jej vyřešily.

Fáze 6: Uzavření a ověření

Po sloučení pull requestu se úkol automaticky zavře (pokud je správně odkazován). Pokud testování odhalí, že problém není plně vyřešený, můžete ho znovu otevřít, abyste mohli pracovat víc.

Osvědčený postup: Po zavření ověřte splnění kritérií přijetí v původním popisu problému. V případě problémů se zabezpečením zvažte dodatečné ověření prostřednictvím testování zabezpečení.

Správa problémů s GitHubem v editoru Visual Studio Code

Visual Studio Code se integruje přímo s issues na GitHubu prostřednictvím GitHub Pull Requests rozšíření. Tato integrace umožňuje:

  • Zobrazení přiřazených problémů bez opuštění editoru
  • Vytvářejte nové problémy v editoru Visual Studio Code.
  • Při práci propojte změny kódu s úkoly.
  • Zkontrolujte podrobnosti problému vedle svého kódu.

Přístup k problémům s GitHubem v editoru Visual Studio Code:

  1. Nainstalujte rozšíření "GitHub Pull Requests and Issues".
  2. Přihlaste se k účtu GitHub.
  3. Zobrazení problémů na panelu GitHub
  4. Filtrovat podle přiřazení, popisků nebo milníků

Tato úzká integrace zjednodušuje váš pracovní postup tím, že při psaní kódu zachová kontext problému.

Proč je důležité efektivní řízení problémů

Jasné sledování problémů zabraňuje vyklouznutí kritických problémů přes trhliny, zejména v zabezpečení. Zvažte tyto reálné scénáře:

  • Menší problémy se stanou velkými incidenty: "Menší problém zabezpečení" v backlogu se může stát vážným incidentem, pokud ho útočníci zjistí jako první. Problémy se zabezpečením v GitHubu jsou viditelné a sledovatelné – použijte tuto viditelnost jako nástroj pro odpovědnost.

  • Ztracené institucionální znalosti: Pokud jsou problémy špatně zdokumentované nebo diskuze probíhají mimo sledovací systém, cenný kontext zmizí. Budoucí vývojáři (včetně vás za šest měsíců) nemusí pochopit, proč byla učiněna určitá rozhodnutí.

  • Zpožděné odpovědi: Bez jasných popisků priority a přiřazení nemusí kritická ohrožení zabezpečení dostávat včasnou pozornost.

Přijměte vývoj řízený problémem: Identifikujte problém, opravte ho, ověřte opravu, zavřete problém a přejděte dál. Tento systematický přístup zajišťuje úplnost a vytváří důvěru v základ kódu.

Shrnutí

GitHub Issues poskytuje základ pro systematické řešení problémů při vývoji softwaru. Abyste je mohli efektivně vyřešit, musíte pochopit, jak číst, interpretovat a spravovat problémy.