Sadarbība ar pull request

06; angliski: Pull request · 6 min lasīšanai

Komandā parasti neviens nesūta izmaiņas tieši uz main. Katra izmaiņa vispirms tiek piedāvāta kā pull request (saīsināti — PR). Tas ir lūgums: „Lūdzu, apskatiet manu zaru un apvienojiet to ar main.” Kolēģi kodu apskata, komentē, un tikai pēc tam to apvieno.

Darba plūsma

  1. Atjaunini main un izveido jaunu zaru:
git switch main
git pull
git switch -c labojums/pogas-krasa
  1. Veic izmaiņas, saglabā un nosūti zaru uz GitHub:
git add .
git commit -m "Izlabo pogas krāsu tumšajā režīmā"
git push -u origin labojums/pogas-krasa
  1. Atver repozitoriju GitHub — augšpusē parādīsies poga Compare & pull request. Uzraksti nosaukumu un aprakstu, tad nospied Create pull request.
  2. Kolēģi pārskata kodu (code review) un atstāj komentārus. Ja vajag labojumus, tos dari tajā pašā zarā (commit + push), un PR atjauninās automātiski.
  3. Kad viss ir apstiprināts, nospied Merge pull request.
  4. Atgriezies uz main un saņem apvienoto versiju:
git switch main
git pull
git branch -d labojums/pogas-krasa

Labs pull request

  • Neliels. 50 rindu izmaiņas izlasīs uzmanīgi, 2000 — pārskrējis ar acīm.
  • Viena tēma. Kļūdas labojumu un jaunu funkciju neapvieno vienā PR.
  • Apraksts: kas mainīts, kāpēc un kā pārbaudīt. Vizuālām izmaiņām pievieno ekrānuzņēmumu.

Piemērs:

Izlabo pogas krāsu tumšajā režīmā

Tumšajā režīmā poga "Sākt mācīties" bija gandrīz neredzama
(zils teksts uz tumši zila fona).

Kā pārbaudīt:
1. Ieslēdz tumšo režīmu
2. Atver sākumlapu — poga ir gaiša ar tumšu tekstu

Koda pārskatīšana

Pārskatīšana ir sadarbība, nevis eksāmens.

  • Komentē kodu, nevis cilvēku: „Šeit varētu noderēt const”, nevis „Tu atkal aizmirsi…”.
  • Uzdod jautājumus: „Kas notiks, ja saraksts būs tukšs?”
  • Uzslavē labus risinājumus — arī tas ir noderīgs komentārs.

Atvērtā koda projekti: fork

Svešā projektā tev nav tiesību veidot zarus. Tad lieto fork: GitHub nospied Fork, un tavā kontā tiks izveidota projekta kopija. Strādā savā kopijā un no tās atver pull request uz oriģinālo projektu. Tieši tā tūkstošiem cilvēku piedalās atvērtā koda projektos.

Uzdevums: izveido GitHub repozitoriju, izveido zaru, nomaini kaut ko README.md failā, atver pull request un apvieno to pats. Pēc tam pamēģini to pašu kopā ar draugu: viens atver PR, otrs to pārskata.

Kursa špikeris

Komanda Ko dara
git init izveido repozitoriju
git clone <url> lejupielādē repozitoriju
git status parāda, kas notiek
git add <fails> sagatavo izmaiņas
git commit -m "…" saglabā versiju
git log --oneline vēsture
git diff nesaglabātās izmaiņas
git switch -c <zars> izveido zaru un pārslēdzas uz to
git merge <zars> apvieno zaru ar pašreizējo
git pull / git push sinhronizē ar GitHub
git revert <id> droši atceļ commit

Gribi sekot savam progresam?

Nodarbības var lasīt bez konta. Ar kontu vari atzīmēt pabeigtās un turpināt, kur paliki.