Kom i gang med GitHub-problemer

  • 8 minutter

GitHub Issues er det indbyggede sporingssystem til opgaver, fejl og funktionsanmodninger i GitHub-lagre. Før du effektivt kan løse problemer ved hjælp af GitHub Copilot, skal du forstå, hvordan du arbejder effektivt med GitHub-problemer.

Hvad er GitHub-problemer?

GitHub Issues giver et samarbejdsarbejdsområde, hvor teams sporer arbejdselementer, dokumenterer problemer og planlægger forbedringer. Hvert problem fungerer som en billet i et sporingssystem – det kan tildeles teammedlemmer, kategoriseres med etiketter, linkes til kodeændringer og beriges med diskussioner og dokumentation.

Tænk på GitHub-problemer som et teams intelligente to-do liste. Hvert element indeholder diskussioner, kodereferencer og metadata for at sikre, at arbejdet ikke falder mellem stolene. Til sikkerhedsfokuseret arbejde giver GitHub Issues synlighed og sporbarhed, der hjælper teams med at reagere systematisk på sårbarheder.

Kernekomponenter i et problem

At forstå strukturen af GitHub-problemer hjælper dig med at læse, administrere og løse dem effektivt.

Titel

Titlen skal være et kortfattet, beskrivende resumé af problemet. Gode titler hjælper teammedlemmer med hurtigt at forstå problemet med et øjeblik.

Eksempler på effektive udgivelsestitler:

  • "SQL-injektionssårbarhed i produktsøgningsslutpunkt"
  • "Svag kryptering i brugeradgangskodelagring"
  • "Risiko for stigennemgang i filoverførselsfunktionalitet"

En velskrevet titel kommunikerer straks både typen af problem (sikkerhedssårbarhed) og dets placering (produktsøgningsslutpunkt).

Beskrivelse

Beskrivelsen er der, hvor detaljerne bor. En omfattende problembeskrivelse bør indeholde følgende oplysninger:

  • Hvad sker der: En klar forklaring på problemet eller kravet.
  • Trin til gendannelse: For fejl, specifikke handlinger, der udløser problemet.
  • Forventet adfærd: Hvad skal der ske i stedet?
  • Hvorfor det er vigtigt: Vigtigheden af at tage fat på dette problem.
  • Acceptkriterier: Sådan kontrolleres, hvornår problemet er løst.

Her er et eksempel på en velstruktureret beskrivelse af sikkerhedsproblemer:

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.

Et velskrevet problem er halvt løst. Det guider udvikleren direkte til problemet uden tvetydighed.

Kommentarer

Kommentarsektionen muliggør teamdiskussion. Teammedlemmer kan:

  • Stil opklarende spørgsmål.
  • Foreslå potentielle løsninger.
  • Del undersøgelsesresultater.
  • Referencerelateret kode eller problemer.
  • Dokumenter beslutninger, der er truffet under afviklingen.

Kommentarer skaber et vidensspor, der hjælper nuværende og fremtidige udviklere med at forstå både problemet og ræsonnementet bag løsningen.

Modtagere

Erhververen er den person, der er ansvarlig for at løse problemet. At have en klar ejer sikrer ansvarlighed og forhindrer problemer i at sygne hen i efterslæbet.

Bedste fremgangsmåde: Tildel altid én primær ejer til et problem. Hvis du er modtageren, er du ansvarlig for at få det til at fungere. At være den udstationerede betyder ikke, at du arbejder alene – du kan samarbejde med andre – men du ejer resultatet.

Labels

Etiketter kategoriserer og prioriterer problemer. Almindelige etiketter omfatter:

  • Typeetiketter: fejl, forbedring, dokumentation, sikkerhed.
  • Prioritetsetiketter: P0-kritisk, P1-høj, P2-medium, P3-lav.
  • Statusetiketter: igangværende, blokeret, behovsgennemgang.
  • Komponentetiketter: backend, frontend, API, database.

Etiketter kan bruges til at filtrere og sortere problemer i lister, hvilket gør det nemmere at fokusere på højt prioriteret eller sikkerhedsrelateret arbejde.

I forbindelse med sikkerhedsproblemer hjælper etiketter teams med hurtigt at filtrere og prioritere sårbarheder, der kræver øjeblikkelig opmærksomhed. En sikkerhedsmærkat kombineret med P0-kritiske signalerer, at problemet kræver hurtig handling.

Milepæle

Milepæle grupperer relaterede problemer mod et fælles mål. Det kan f.eks. være en versionsudgivelse eller en projektfase. Selvom det ikke er afgørende for løsning af individuelle problemer, hjælper milepæle teams med at koordinere arbejdet og spore fremskridt mod større mål.

Undersøg livscyklussen for et problem

Problemer bevæger sig gennem flere faser fra oprettelse til løsning. At forstå denne livscyklus hjælper dig med at håndtere problemer effektivt.

Trin 1: Skabelse

Problemer kan oprettes af udviklere, testere eller brugere, der identificerer problemer eller muligheder for forbedringer. Sikkerhedsproblemer kan opdages via:

  • Kode anmeldelser.
  • Automatiserede sikkerhedsscanninger.
  • Indtrængningstest.
  • Bruger rapporterer.
  • Sikkerhedsrevisioner.

Når du opretter et problem, skal du inkludere tilstrækkelig kontekst og acceptkriterier. Dette sætter klare forventninger til, hvornår problemet anses for løst.

Fase 2: Triage

Under triage skal en teamleder eller udpeget person:

  • Gennemgår nye numre.
  • Tildeler prioritetsniveauer.
  • Tilføjer passende etiketter.
  • Tildeler problemet til en udvikler.
  • Links relaterede problemer eller dokumentation.

Problemer med høj alvorsgrad, især sikkerhedssårbarheder, markeres til øjeblikkelig opmærksomhed. Sikkerhedsproblemer bør aldrig sidde i et efterslæb uden vurdering.

Trin 3: Undersøgelse og diskussion

Den tildelte udvikler undersøger problemet. Udviklere kan udføre en eller flere af følgende opgaver under deres undersøgelse:

  • Stil opklarende spørgsmål i kommentarer.
  • Dokumenter resultater fra kodeanalyse.
  • Foreslå potentielle løsninger.
  • Anmod om yderligere oplysninger.
  • Identificer relaterede kodeområder, der er berørt.

Denne diskussionsfase sikrer, at alle forstår problemet, før de implementerer en rettelse.

Trin 4: Implementering

Udvikleren opretter en funktionsgren og implementerer rettelsen. Implementeringsprocessen indebærer typisk følgende opgaver:

  • Skrivning eller ændring af kode.
  • Tilføjelse eller opdatering af tests.
  • Bekræftelse af rettelsen lokalt.
  • Forberedelse af en pull-anmodning (PR).

Trin 5: Sammenkædning af commits og pull-anmodninger

GitHub forbinder automatisk problemer med kodeændringer, når du refererer til dem i bekræftelsesmeddelelser eller PR-beskrivelser ved hjælp af nøgleord:

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

Eksempel på bekræftelsesmeddelelse:

Fix SQL injection vulnerability in search function

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

Fixes #42

Ved at bruge nøgleord til at referere til problemer skabes sporbarhed mellem problemet og dets løsning. Når pull-anmodningen flettes, lukker GitHub automatisk det problem, der refereres til. Denne automatisering sikrer, at problemer ikke forbliver åbne, når de er løst, og opretter en permanent forbindelse mellem problembeskrivelsen og de kodeændringer, der løste den.

Trin 6: Lukning og verifikation

Når pull-anmodningen flettes, lukkes problemet automatisk (hvis der henvises til det korrekt). Hvis testen afslører, at problemet ikke er helt løst, kan det genåbnes for mere arbejde.

Bedste fremgangsmåde: Når du har lukket, skal du kontrollere, at acceptkriterierne i den oprindelige problembeskrivelse er opfyldt. I forbindelse med sikkerhedsproblemer kan du overveje ekstra bekræftelse gennem sikkerhedstest.

Administrer GitHub-problemer i Visual Studio Code

Visual Studio Code integreres direkte med GitHub-problemer via GitHub Pull-anmodningsudvidelsen. Denne integration giver dig mulighed for at:

  • Se tildelte problemer uden at forlade editoren.
  • Opret nye problemer fra Visual Studio Code.
  • Linkkode ændres til problemer, mens du arbejder.
  • Gennemgå problemoplysninger sammen med din kode.

Sådan får du adgang til GitHub-problemer i Visual Studio Code:

  1. Installer udvidelsen "GitHub Pull-anmodninger og -problemer".
  2. Log på din GitHub-konto.
  3. Få vist problemer i GitHub-panelet.
  4. Filtrer efter modtager, etiketter eller milepæle.

Denne tætte integration strømliner din arbejdsgang ved at holde problemkonteksten synlig, mens du koder.

Hvorfor effektiv problemhåndtering er vigtig

Klar problemsporing forhindrer kritiske problemer i at glide gennem sprækkerne, især inden for sikkerhed. Overvej disse scenarier fra den virkelige verden:

  • Mindre problemer bliver til større hændelser: Et "mindre" sikkerhedsproblem i backloggen kan blive en alvorlig hændelse, hvis angribere opdager det først. Sikkerhedsproblemer i GitHub-problemer er synlige og sporbare – brug denne synlighed som et ansvarlighedsværktøj.

  • Tabt institutionel viden: Når problemer er dårligt dokumenteret, eller diskussioner finder sted uden for sporingssystemet, forsvinder værdifuld kontekst. Fremtidige udviklere (inklusive dig om seks måneder) forstår måske ikke, hvorfor visse beslutninger blev truffet.

  • Forsinkede svar: Uden klare prioritetsetiketter og modtagere får kritiske sikkerhedssårbarheder muligvis ikke rettidig opmærksomhed.

Omfavn problemdrevet udvikling: Identificer problemet, løs det, bekræft løsningen, luk problemet, og kom videre. Denne systematiske tilgang sikrer fuldstændighed og opbygger tillid til din kodebase.

Oversigt

GitHub Issues danner grundlaget for systematisk problemløsning inden for softwareudvikling. Det er vigtigt at forstå, hvordan man læser, fortolker og håndterer problemer effektivt, før du kan løse dem effektivt.