Kaip buvo organizuotas jūsų komandos kodų peržiūros procesas?

Mes naudojome bendradarbiavimą naudodami versijų kontrolės sistemą Git ir platformą saugyklų valdymui (pavyzdžiui, Bitbucket arba GitLab). Kodo peržiūros procesas buvo organizuotas taip:

1. Šakos kūrimas: Kūrėjas sukuria atskirą šaką naujai funkcijai ar klaidos pataisymui (git checkout -b feature/my-new-feature).
2. Kūrimas ir įsipareigojimai: Šakoje atliekami pakeitimai, kurie įrašomi kaip įsipareigojimai (git add ., git commit -m "Initial feature implementation").
3. Pusht į nuotolinį saugyklą: Šaka siunčiama į nuotolinę saugyklą (git push origin feature/my-new-feature).
4. Pull/Merge užklausos sukūrimas: Kūrėjas sukuria Pull Request (Bitbucket) arba Merge Request (GitLab), nurodydamas tikslinę šaką (pvz., develop arba main). Aprašyme pateikiamas trumpas pakeitimų aprašymas, užduočių nuorodos į sekimo sistemą (Jira, Trello ir kt.) ir pridėti failai (screenshot'ai, vaizdo įrašai, diagramos).
5. Peržiūros paskyrimas: Paskiriami vienas arba du komandos nariai peržiūrai.
6. Peržiūros procesas: Peržiūrėtojai peržiūri pakeitimus Pull/Merge užklausoje. Jie gali palikti komentarus, siūlyti patobulinimus, užduoti klausimus:

   // Pavyzdinis komentaras peržiūros metu
   function fetchData() {
     // Galbūt reikėtų pridėti klaidų apdorojimą duomenų užklausai
     return fetch('/api/data');
   }
   

7. Pakeitimų įvedimas remiantis peržiūros rezultatais: Kūrėjas įveda būtinus pakeitimus savo šakoje ir sukuria naujus įsipareigojimus.
8. Pull/Merge užklausos atnaujinimas: Pakeitimai automatiškai rodomi Pull/Merge užklausoje po jų įkėlimo į nuotolinę saugyklą.
9. Pakartotinė peržiūra: Peržiūrėtojai vėl peržiūri pakeitimus ir suteikia patvirtinimą.
10. Šakos sujungimas: Po patvirtinimo šaka sujungiama su tiksline šaka (dažniausiai automatiškai platformos priemonėmis po CI/CD pipelino praeities).

Taip pat naudojome CI/CD pipeline, kuris automatiškai paleidžia vienetinius testus, statinę kodo analizę (ESLint, Prettier) ir projekto statybą prieš sujungimą, kas padėjo anksti aptikti klaidas.

Sėkmingo peržiūros kriterijai buvo:

• Atitiktis užduoties reikalavimams.
• Komandos kodo stiliaus laikymasis.
• Kritinės logikos vienetinių testų buvimas.
• Akivaizdžių klaidų ir "kostilų" nebuvimas.
• Kodo aiškumas kitiems komandos nariams.