Sobes.tech
Middle+

Kuidas oli teie meeskonnas korraldatud koodi ülevaatamise protsess?

sobes.tech AI

Vastus AI-lt

Me kasutame koostööd ar versioonikontrollisüsteemi Git ja hoidlate haldamise platvormi (näiteks Bitbucket või GitLab). Koodi ülevaatamise protsess oli organiseeritud järgmiselt:

  1. Haru loomine: Arendaja loob eraldi haru uue funktsiooni või vea parandamiseks (git checkout -b feature/my-new-feature).
  2. Arendus ja commitid: Harus tehakse muudatusi, mis salvestatakse commitidena (git add ., git commit -m "Initial feature implementation").
  3. Push kaughoidlasse: Haru saadetakse kaughoidlasse (git push origin feature/my-new-feature).
  4. Pull/Merge taotluse loomine: Arendaja loob Pull Requesti (Bitbucketis) või Merge Requesti (GitLabis), märkides sihiharuks (näiteks develop või main). Kirjelduses on lühike muudatuste kirjeldus, ülesannete lingid jälgimissüsteemis (Jira, Trello jne) ja lisatud failid (ekraanipildid, videod, diagrammid).
  5. Revidentide määramine: Määratakse üks või kaks arendajat ülevaatamiseks.
  6. Ülevaatuse protsess: Revidendid vaatavad muudatusi Pull/Merge taotluses. Nad võivad jätta kommentaare, pakkuda parendusi, esitada küsimusi:
    // Näide kommentaarist ülevaatuse ajal
    function fetchData() {
      // Võib-olla tuleks lisada andmepäringu veahaldus
      return fetch('/api/data');
    }
    
  7. Muudatuste tegemine ülevaatuse tulemustel põhinevalt: Arendaja teeb vajalikud muudatused oma haru ja loob uued commitid.
  8. Pull/Merge taotluse uuendamine: Muudatused kuvatakse automaatselt Pull/Merge taotluses pärast nende kaughoidlasse pushimist.
  9. Uuesti ülevaatamine: Revidendid vaatavad muudatused uuesti läbi ja annavad heakskiidu.
  10. Haru ühendamine: Pärast heakskiitu ühendatakse haru sihtharuga (tavaliselt automaatselt platvormi vahenditega CI/CD pipeline läbimisel).

Me kasutame ka CI/CD pipeline, mis automaatselt käivitab üksustestid, staatilise koodi analüüsi (ESLint, Prettier) ja projekti koostamise enne ühendamist, mis aitas varakult avastada vigu.

Eduka läbivaatamise kriteeriumid hõlmasid:

  • Nõuete vastavus.
  • Meeskonna koodistiili järgimine.
  • Kriitilise loogika üksustestide olemasolu.
  • Silmatorkavate vigade ja "kostiilide" puudumine.
  • Koodi arusaadavus teistele meeskonnaliikmetele.