Hvad GitHub Copilot tilføjer til gennemgangsprocessen
Kodegennemgange og pull-anmodningsgennemgange er afgørende for kvaliteten, men de kan også være tidskrævende og ujævne. Udviklere jonglerer ofte med flere sprog, inkonsekvent formatering og store forskelle, mens de forsøger at give tankevækkende feedback. GitHub Copilot hjælper med at lette denne arbejdsbyrde ved at fungere som en samarbejdskorrekturlæser og assistent. Den fanger almindelige problemer, udkast til gennemgå kommentarer, opsummerer pull-anmodninger og fremhæver endda sikkerhedsrisici - hvilket giver korrekturlæsere et klart udgangspunkt. Med brugerdefinerede gennemgangsinstruktioner kan du guide Copilot til at holde øje med de samme mønstre, som du gør, hvilket sikrer konsistens på tværs af teams og lagre.
Ved afslutningen af denne enhed vil du kunne:
- Identificer de vigtigste funktioner i Copilot i kodegennemgange.
- Forklar, hvordan PRU'er låser op for avancerede gennemgangsfunktioner.
- Anerkend forskellige måder, hvorpå Copilot-gennemgang supplerer og hjælper udviklere.
Nøglefunktioner i Copilot i kodeanmeldelser
Copilot introducerer flere funktioner, der er designet til at strømline anmeldelser:
PR-resuméer: Copilot kan automatisk udarbejde pull-anmodningsbeskrivelser, der indeholder en klar oversigt over ændringer og en liste over berørte filer. Dette sikrer, at korrekturlæsere starter med kontekst, ikke gætværk.
Sikkerhedsrettelser: Med Copilot-kodegennemgang integreret i GitHub Code Scanning markeres sårbarheder på tværs af sprog. I JavaScript kan Copilot f.eks. spotte ikke-rensede input, der sendes til eval() og kommentere:
"eval() med brugerinput kan føre til kodeinjektion. Udskift den med en sikker parser som JSON.parse()." Det tilbyder derefter en inline-patch, der er tilpasset dit lagers sikkerhedsretningslinjer.
Linje-for-linje-forklaringer: Korrekturlæsere kan fremhæve kode og bede Copilot om at forklare funktionaliteten, hvilket hjælper dem med hurtigt at forstå ukendt kode.
Udarbejdelse af kommentarer: Copilot kan generere anmeldelseskommentarer baseret på bedste praksis eller teamretningslinjer, hvilket gør feedback klar og handlingsorienteret.
Anmeldelser i din IDE: Ud over at arbejde direkte på GitHub.com kan Copilot også gennemgå kode i din IDE. Dette giver udviklere mulighed for at fange og løse problemer, før de åbner en pull-anmodning, hvilket fremskynder processen og reducerer omarbejde.
Forstå, hvordan PRU'er låser op for avancerede gennemgangsfunktioner
PRU'er driver disse avancerede funktioner. Hvis du f.eks. tildeler Copilot som PR-korrekturlæser, bruges en PRU, hver gang den sender kommentarer. Når de kombineres med brugerdefinerede .github/copilot-instructions.md filer, tilpasser PRU-drevne anmeldelser sig til dit teams regler, uanset om de fokuserer på læsbarhed, sikkerhed eller stil.
Eksempel:
Uden Copilot kan en PR indeholde vage kommentarer fra en anmelder som "Løs sikkerhedsproblem her". Ved hjælp af Copilot + PRU'er bliver gennemgangen:
"Brugen af introducerer en sårbarhed i forbindelse med exec() kodeinjektion. Overvej at erstatte det med subprocess.run() for sikrere kommandoudførelse. Her er et forslag til patch:"
Og det giver koderettelsen inline.
Fem forskellige måder, hvorpå Copilot-gennemgang hjælper udviklere
Dernæst gennemgår vi, hvordan Copilot-gennemgang kan hjælpe dig med at arbejde smartere med:
- Forslag til kodegennemgang
- Copilot-anmeldelser på tværs af flere sprog
- Formatering af data i pullanmodninger
- Skrivning af effektive pull-anmodningsresuméer
- Forklaring og gennemgang af kode
Brug af Copilot-forslag i kodegennemgange
Når du gennemgår en pull-anmodning, kan du få øje på områder, der kan forbedres, men du har ikke tid til selv at udarbejde det perfekte eksempel eller uddrag. GitHub Copilot hjælper med at udfylde dette hul uden at overtage forfatterens arbejde. Inde i visningen "Filer ændret" kan du fremhæve en linje eller blok af kode og bede Copilot om at foreslå forbedringer eller markere potentielle problemer. Copilot genererer derefter et konkret, kontekstbevidst forslag, som du kan kopiere ind i din anmeldelseskommentar, hvilket gør din feedback klarere og lettere for forfatteren at handle på.
For eksempel, mens du gennemgår en Ruby-fil med gentaget logik, kan du fremhæve de relevante linjer og spørge:
"Foreslå en renere Ruby-refaktor for denne gentagne kode."
Copilot vil foreslå en opdateret version, der følger almindelige Ruby-bedste praksisser. Du kan indsætte dens anbefaling (eller dele af den) i din anmeldelseskommentar sammen med din egen forklaring. Dette holder dig fokuseret på den overordnede kvalitet og design, samtidig med at du stadig giver forfatteren handlingsorienteret feedback af høj værdi - uden at udviske grænsen mellem gennemgang og kodning på deres vegne.
Korrekturlæsning på tværs af flere sprog
Når du anmoder om en kodegennemgang, kan Copilot automatisk fremhæve områder, der ikke følger bedste praksis eller teamretningslinjer
Copilot vil hurtigt generere forbedringer, der er i overensstemmelse med sprogets konventioner, så du kan give stærkere og mere præcis feedback på anmeldelser, selv uden for dit primære ekspertiseområde.
Formatering af data til pullanmodninger
Pull-anmodninger er meget tydeligere, når de indeholder velformateret kontekst såsom målepunkter, skærmbilleder eller testresultater. Holdene glemmer dog ofte at formatere dette indhold konsekvent. GitHub Copilot kan fungere som et andet sæt øjne under kodegennemgang, automatisk markere dårligt formaterede tabeller i en pull-anmodningsbeskrivelse og foreslå en renere version, der stemmer overens med din virksomheds retningslinjer for stil.
Eksempel: En udvikler sender en pullanmodning med følgende tabel over sideindlæsningstider. Den er svær at læse og følger ikke holdets Markdown-stilguide:
| Testkørsel | LoadTimeBefore | LoadTimeAfter |
|---|---|---|
| 1.3 | 1.2 | |
| 1.2 | 1.1 | |
| 1.1 | 0.885 | |
| 1.3 | 1.3 | |
| 1.2 | 0.918 | |
| Average | 1.22 | 1.0806 |
Under gennemgangen skriver Copilot en kommentar:
"Denne tabel følger ikke dit lagers Markdown-retningslinjer. Her er en ryddet version baseret på din virksomheds stilguide."
Og den indeholder en korrigeret version, der er klar til at blive indsat i PR-beskrivelsen:
| Testkørsel | Indlæsningstid før (sekunder) | Indlæsningstid efter opdateringer (sekunder) |
|---|---|---|
| 1 | 1.3 | 1.2 |
| 2 | 1.2 | 1.1 |
| 3 | 1.1 | 0.885 |
| 4 | 1.3 | 1.3 |
| 5 | 1.2 | 0.918 |
| Gennemsnitlig | 1.22 | 1.0806 |
Anmelderen kan acceptere Copilots forslag med et enkelt klik, hvilket sikrer, at PR'en følger virksomhedens stil uden at bruge tid på at omformatere.
Dette viser, at Copilot fungerer som en automatisk korrekturlæser (ikke en kodningsagent): den ser den uformaterede tabel, anvender virksomhedens retningslinjer fra .github/copilot-instructions.mdog leverer en korrigeret version inline.
Skrivning af effektive pullanmodningsoversigter
At skrive PR-beskrivelser er ofte det sidste skridt i processen og kan føles som en forhindring. Copilot gør dette nemmere. Fra PR-beskrivelseseditoren kan du bruge Copilot-ikonet til at generere en kladdeoversigt eller -disposition. Selvom du foretager redigeringer, sparer du tid ved at have et velstruktureret udgangspunkt og sikrer, at korrekturlæsere har de oplysninger, de har brug for.
Forklaring og gennemgang af kode
Nogle gange er du måske ikke bekendt med koden i en pull-anmodning. I stedet for at kæmpe dig igennem det, kan du bede Copilot om at forklare ændringerne. Copilot kan også køre en indledende gennemgang af dine egne pull-anmodninger, før du anmoder om feedback fra teammedlemmer. Dette hjælper med at fange mindre problemer, validere bedste praksis og giver dig mere tillid til kvaliteten af din indsendelse.
Du ved nu, hvad Copilot er i stand til, når det kommer til kodeanmeldelser. Lad os derefter se, hvordan du bruger Copilot-anmeldelser direkte på GitHub.com.