Mitä GitHub Copilot lisää tarkistusprosessiin
Kooditarkistukset ja pull-pyyntöjen tarkistukset ovat olennaisia laadun kannalta, mutta ne voivat myös olla aikaa vieviä ja epätasaisia. Kehittäjät jongleeraavat usein useita kieliä, epäjohdonmukaista muotoilua ja suuria eroavaisuuksia yrittäessään antaa harkittua palautetta. GitHub Copilot helpottaa tätä työmäärää toimimalla yhteistoiminnallisena tarkistajana ja avustajana. Se havaitsee yleiset ongelmat, luonnostelee kommentteja, tekee yhteenvedon pull-pyynnöistä ja jopa korostaa tietoturvariskejä antaen tarkastajille selkeän lähtökohdan. Mukautettujen tarkistusohjeiden avulla voit ohjata Copilotia tarkkailemaan samoja malleja kuin sinä, mikä varmistaa johdonmukaisuuden tiimien ja tietovarastojen välillä.
Tämän jakson loppuun mennessä voit:
- Tunnista Copilotin tärkeimmät ominaisuudet kooditarkistuksissa.
- Selitä, miten PRU:t avaavat edistyneitä tarkistusominaisuuksia.
- Tunnista erilaisia tapoja, joilla Copilot-arviointi täydentää ja auttaa kehittäjiä.
Copilotin tärkeimmät ominaisuudet kooditarkistuksissa
Copilot esittelee useita ominaisuuksia, jotka on suunniteltu virtaviivaistamaan tarkastuksia:
PR-yhteenvedot: Copilot voi automaattisesti laatia pull-pyyntöjen kuvaukset, jotka sisältävät selkeän yhteenvedon muutoksista ja luettelon tiedostoista, joita asia koskee. Tämä varmistaa, että tarkistajat aloittavat kontekstista, eivät arvailuista.
Tietoturvakorjaukset: Kun Copilot-koodin tarkistus on integroitu GitHub Code Scanningiin, haavoittuvuudet merkitään eri kielillä. Esimerkiksi JavaScriptissä Copilot voi havaita eval()-tiedostoon välitetyn desinfioimattoman syötteen ja kommentoida:
"eval() käyttäjän syötteellä voi johtaa koodin injektioon. Korvaa se turvallisella jäsentimellä, kuten JSON.parse()." Sitten se tarjoaa sisäisen korjaustiedoston, joka on linjassa arkistosi tietoturvaohjeiden kanssa.
Rivikohtaiset selitykset: Tarkastajat voivat korostaa koodia ja pyytää Copilotia selittämään toiminnallisuuden, mikä auttaa heitä ymmärtämään tuntematonta koodia nopeasti.
Kommenttien laatiminen: Copilot voi luoda tarkistuskommentteja parhaiden käytäntöjen tai tiimin ohjeiden perusteella, mikä tekee palautteesta selkeää ja käyttökelpoista.
Arvostelut IDE:ssäsi: Sen lisäksi, että Copilot työskentelee suoraan GitHub.com, se voi myös tarkistaa koodia IDE:n sisällä. Näin kehittäjät voivat havaita ja ratkaista ongelmat ennen pull-pyynnön avaamista, mikä nopeuttaa prosessia ja vähentää uudelleenkäsittelyä.
Ymmärrä, miten PRU:t avaavat edistyneitä tarkistusominaisuuksia
PRU:t tehostavat näitä edistyneitä ominaisuuksia. Esimerkiksi Copilotin määrittäminen PR-tarkastajaksi käyttää PRU:ta aina, kun se julkaisee kommentteja. Yhdistettynä mukautettuihin .github/copilot-instructions.md tiedostoihin PRU-pohjaiset arvostelut ovat linjassa tiimisi sääntöjen kanssa riippumatta siitä, keskittyvätkö ne luettavuuteen, turvallisuuteen vai tyyliin.
Example:
Ilman Copilotia PR saattaa sisältää epämääräisiä kommentteja arvioijalta, kuten "Korjaa tietoturvaongelma täällä". Copilot + PRU:n avulla arvostelusta tulee:
"Käyttö exec() tuo mukanaan koodin injektiohaavoittuvuuden. Harkitse sen korvaamista komennon subprocess.run() turvallisemman suorittamisen vuoksi. Tässä on ehdotettu korjaustiedosto:"
Ja se tarjoaa koodin korjauksen rivissä.
Viisi erilaista tapaa, joilla Copilot-arviointi auttaa kehittäjiä
Seuraavaksi tarkastelemme, miten Copilot-arvostelu voi auttaa sinua työskentelemään älykkäämmin:
- Koodin tarkistus Ehdotukset
- Copilot-tarkistukset useilla kielillä
- Pull-pyyntöjen tietojen muotoilu
- Tehokkaiden pull-pyyntöjen yhteenvetojen kirjoittaminen
- Koodin selittäminen ja tarkistaminen
Copilot-ehdotusten käyttäminen koodin tarkistuksissa
Kun tarkastelet pull-pyyntöä, saatat huomata alueita, joita voitaisiin parantaa, mutta sinulla ei ole aikaa laatia täydellistä esimerkkiä tai katkelmaa itse. GitHub Copilot auttaa täyttämään tämän aukon ottamatta kirjailijan työtä haltuunsa. Pull-pyynnön "Tiedostot muutettu" -näkymässä voit korostaa koodirivin tai -lohkon ja pyytää Copilotia ehdottamaan parannuksia tai merkitsemään mahdollisia ongelmia. Copilot luo sitten konkreettisen, kontekstitietoisen ehdotuksen, jonka voit kopioida arvostelukommenttiisi, mikä tekee palautteestasi selkeämmän ja kirjoittajan helpomman toimia.
Kun esimerkiksi tarkastelet Ruby-tiedostoa toistuvalla logiikalla, voit korostaa asiaankuuluvat rivit ja kysyä:
"Ehdota puhtaampaa Ruby-refaktoria tälle toistuvalle koodille."
Copilot ehdottaa päivitettyä versiota, joka noudattaa Rubyn yleisiä parhaita käytäntöjä. Voit liittää sen suosituksen (tai osia siitä) arvostelukommenttiisi oman selityksesi kanssa. Tämä pitää sinut keskittyneenä yleiseen laatuun ja suunnitteluun ja antaa silti kirjoittajalle käyttökelpoista, arvokasta palautetta hämärtämättä rajaa tarkistamisen ja koodaamisen välillä.
Tarkistaminen useilla kielillä
Kun pyydät koodin tarkistusta, Copilot voi automaattisesti korostaa alueita, jotka eivät noudata parhaita käytäntöjä tai tiimin ohjeita
Copilot luo nopeasti parannuksia, jotka ovat linjassa kielen käytäntöjen kanssa, jolloin voit antaa vahvempaa ja tarkempaa arvostelupalautetta myös ensisijaisen osaamisalueesi ulkopuolella.
Pull-pyyntöjen tietojen muotoilu
Pull-pyynnöt ovat paljon selkeämpiä, kun ne sisältävät hyvin muotoillun kontekstin, kuten mittareita, näyttökuvia tai testituloksia. Tiimit unohtavat kuitenkin usein muotoilla tämän sisällön johdonmukaisesti. GitHub Copilot voi toimia toisena silmäparina koodin tarkistuksen aikana, merkitä automaattisesti huonosti muotoillut taulukot pull-pyynnön kuvauksessa ja ehdottaa puhtaampaa versiota, joka on linjassa yrityksesi tyyliohjeiden kanssa.
Esimerkki: Kehittäjä lähettää pull-pyynnön, jossa on seuraava taulukko sivun latausajoista. Sitä on vaikea lukea, eikä se noudata tiimin Markdown-tyyliopasta:
| Koeajo | LatausaikaEnnen | LatausaikaJälkeen |
|---|---|---|
| 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 |
Tarkistuksen aikana Copilot lähettää kommentin:
"Tämä taulukko ei noudata arkistosi Markdown-ohjeita. Tässä on siivottu versio, joka perustuu yrityksesi tyylioppaaseen."
Ja se sisältää korjatun version, joka on valmis liitettäväksi PR-kuvaukseen:
| Koeajo | Latausaika ennen (sekuntia) | Latausaika päivitysten jälkeen (sekuntia) |
|---|---|---|
| 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 |
| Keskiarvo | 1.22 | 1.0806 |
Arvioija voi hyväksyä Copilotin ehdotuksen yhdellä napsautuksella ja varmistaa, että PR noudattaa yrityksen tyyliä käyttämättä aikaa uudelleenmuotoiluun.
Tämä näyttää Copilotin toimivan automaattisena tarkistajana (ei koodausagenttina): se näkee muotoilemattoman taulukon, soveltaa yrityksen ohjeita .github/copilot-instructions.mdja toimittaa korjatun version tekstiin.
Tehokkaiden pull-pyyntöjen yhteenvetojen kirjoittaminen
PR-kuvausten kirjoittaminen on usein prosessin viimeinen vaihe ja voi tuntua esteeltä. Copilot helpottaa tätä. PR-kuvauseditorissa voit käyttää Copilot-kuvaketta luonnoksen yhteenvedon tai jäsennyksen luomiseen. Vaikka tekisit muokkauksia, hyvin jäsennelty lähtökohta säästää aikaa ja varmistaa, että tarkistajilla on tarvitsemansa tiedot.
Koodin selittäminen ja tarkistaminen
Joskus pull-pyynnön koodi ei ehkä ole sinulle tuttu. Sen sijaan, että kamppailisit sen läpi, voit pyytää Copilotia selittämään muutokset. Copilot voi myös suorittaa alustavan tarkistuksen omista PR:istäsi ennen kuin pyydät palautetta tiimikavereiltasi. Tämä auttaa havaitsemaan pienemmät ongelmat, validoi parhaat käytännöt ja antaa sinulle enemmän luottamusta lähetyksesi laatuun.
Tiedät nyt, mihin Copilot pystyy koodin tarkistamisessa. Katsotaanpa seuraavaksi, kuinka voit käyttää Copilot-arvosteluja suoraan GitHub.com.