Koman w pou w kreye yon bon Pull Request
Sa poko rive w pou fè yon PR , lè w mete yon moun review l , li di w ok, la l gade l, men l pa jan m review l oubyen pran 3 jou pou l baw yon feedback epi feedback se de komantè tankou kisa sa ye ? poukisa sa ? kisa kod sa fè ?
Si sa rive w mwen ka garanti w ke Pull Request ou an pat bon.
Tout Sr Developer konnen yon bon PR le l wè l , li Souvan klè , fasil pou l li , e fasil pou l bay feedback, tandiske yon move PR difisil pou w konpran n, e li pran yon pakèt tan w pou w review, pa bliye reviewer an ap travail tou, li pa gen anpil tan.
Sa gen lontan nan premye travay mwen ke m te fè yon mwa sèlman, m si se te pull request mwen yo ki t fè m pèdi travail lan.
Kounya m vin ap jere projè avèk kèk developer, m vin wè se pa yon bagay ki evidan pou tout developer konn fè bon pull request, se pou sa nan atik sa m pral eseye klarifye kisak yon bon pull request , koman pou w ekri youn, e poukisa ou dwe ekri youn ki bon.
Kisa sa vle di yon PR ki bon ?
Ou ka pa kwè sa, men yon bon PR preske pa gen anyen pou wè avèk kod ou ekri an. Ou pa bezwen yn Sr developer avèk anpil ezperyans pouw fè yon bon PR. bon PR se youn ki fasil pou w konprann , e fasil pou analize e ki reponn kesyon avan menm yo poze yo. M pral pale plis sou sa nan atik sa.
Kek siy yon bon pull request:
- Si w jwenn feedback ki klè : Feedback pa yon siy ki di PR ou an pa bon, se pito yon siy ki di kod an mande yon ti travay an plus. Sa se 2 bagay ki diferan
- Yo review l rapid : si yo komanse review PR ou an vitse bon siy, Mwen pap review yon PR mw konnen ki pral pran anpil tanm, e kap fè m paka focus sou travay mwen.
- Ou pa jwenn anpil kestyon : Si pull request lan gen anpil “Poukisa?” and “Kijan?” “Koman?” Sa vle di PR ou an pa bon. Si l t bon li tap klarifye bagay sa yo deja , oubyen tap reponn a kestyon sa yo deja.
Koman pou w ekri yon bon Pull Request
Byen chwazi moun kap review l lan.
Li pi bon si w chwazi yon moun ki travay sou codebase lan deja , Si PR lan gen bagay ki ka afekte lòt pati nan kod lan , lap bon pou w ajoute yn Sr Developer sou li, li pa nesesè pou ajoute tout moun nan ekip lan kòm reviewer sou li tou.
Mete yon deskripsyon detaye nan PR ou an.
Asire w ke deskripsyon w lan gen ase detay ki reponn a kestyon sa yo :
- Kisa chanjman yo ta sipoze fè?
- Eske fè chanjman sou achitekti sistèm lan, e poukisa ou itilize yon teknik ou pa ?
- Yon ti explikasyon sou chanjman w fe nan chak fichye si yo pa fasil pou w wè
Pale de ris kod ou an pote sak ki k afekte lòt pati nan sistèm lan.
Si kod ou an gen ris ladan l ou dwe pale de li, sa ap fè moun bay PR ou an plis atansyon kise yon bon bagay. Kisa yon PR riske ye ? Ebyen se yon PR ki gen kod ke w pa kwè a 100% ke li pap afekte lòt fonktyonalite nan systèm lan, sitou si w fèk antre nan yon travay e ke w pa konn tout systèm lan.
Men kèk bagay ki k fè w wè si yon PR gen risk ladan l:
- Pèdi nan pèfòmans: Si w panse chanjman ou fe nan kod ou yo k afekte pèfomans sistèm lan?
- Sekirite an redwi: Si panse kod an k kreye vilnerabilite sou sistèm lan ? tankou SQL injection, DDoS, ou itilize pakaj npm ki pa sekirize ?
- Edge cases: Eske asire w ke w jere tout bagay , e ke pa gen yon ti bagay ou bliye ki ka afekte lòt pati nan sistèm lan.
Komante kod lan
Nan antrepriz wap travay lan ap etabli fason pou w komante, ou ka ajoute komantè nan kek pati nan kod lan ke ou wè ki konplèx, ou k toujou tag moun sou pati ou konnen kap konsène yo.
Èske m bliye pale de yon bagay ? Èske gen yon lòt bagay ki fè yon Pull Request bon? Fè m konnen nan komantè yo.
Si w te renmen atik sa ou ka swiv mwen! Sa a ankouraje ekri plis atik an kreyol sou teknoloji.
