Pull Request Vadlīnijas

Lai nodrošinātu vienmērīgu un efektīvu pārskatīšanas procesu, gan līdzdalībniekiem, gan pārskatītājiem, iesniedzot un pārskatot pull pieprasījumus (PR), ir jāievēro šādas vadlīnijas.

Līdzdalībniekiem

1. Izsmeļoši virsraksti un apraksti
   • Izmanto skaidrus un kodolīgus virsrakstus, kas apkopo izmaiņas.
   • Sniedziet detalizētus aprakstus par to, ko PR dara, kāpēc izmaiņas ir nepieciešamas, un jebkādu attiecīgo kontekstu.
2. Saite uz Problēmām
   • PR titulā pievieno GH-PROBLĒMAS-NR, lai sasaistītu PR ar attiecīgo problēmu. Tas ir nepieciešams visām PR.
3. Mazas, Koncentrētas Izmaiņas
   • Mērķis ir saglabāt PR mazus un koncentrēties uz vienu jautājumu vai funkciju. Tādējādi pārskatītājiem ir vieglāk saprast un sniegt atsauksmes.
4. Koda Kvalitāte
   • Pārliecinieties, ka tavs kods atbilst projekta kodēšanas standartiem un labākajai praksei.
   • Iekļauj komentārus tur, kur nepieciešams izskaidrot sarežģītu loģiku.
5. Testēšana
   • Pirms PR iesniegšanas rūpīgi pārbaudiet izmaiņas.
   • Ja piemērojams, iekļaujiet vienību testus vai integrācijas testus, lai pārbaudītu izmaiņas.
6. Dokumentācija
   • Atjauno vai pievieno dokumentāciju pēc nepieciešamības, lai atspoguļotu izmaiņas.
7. Commit Ziņojumi
   • Izmanto skaidrus un aprakstošus commit ziņojumus, kas seko conventional commits formātam.
8. Pārbaudi Konfliktus
   • Pirms PR iesniegšanas pārliecinies, vai tavs zars ir aktuālajā versijā ar bāzes zaru, lai samazinātu apvienošanas konfliktus.

Pārskatītājiem

• Jums ir rūpīgi jāpārskata PR un nepieciešamības gadījumā jāpieprasa izmaiņas
• Sniedz konstruktīvas atsauksmes un ieteikumus uzlabojumiem.
• Pārbaudiet, vai izmaiņas atbilst projekta kodēšanas standartiem un paraugpraksei.
• Izvietojiet PR, izmantojot dokploy integrāciju, lai nodrošinātu, ka izmaiņas darbojas, kā paredzēts.
• Pārliecinieties, ka dokumentācija tiek atjaunināta pēc nepieciešamības.
• Apstipriniet PR tikai tad, kad esat apmierināts ar izmaiņām un visas pārbaudes ir nokārtotas.