Skip to main content

5 మంచి కోడ్ సమీక్షకుడిగా మారడానికి మీకు సహాయపడే చిట్కాలు - మ్యూస్

Anonim

జూనియర్ సాఫ్ట్‌వేర్ ఇంజనీర్‌గా, మంచి కోడర్‌గా ఎలా మారాలో తెలుసుకోవడానికి నేను అందుకున్న కోడ్ సమీక్ష వ్యాఖ్యలను ఎల్లప్పుడూ పరిశీలించాను. నా మొదటి కోడ్ సమీక్షను ప్రయత్నించడానికి సమయం వచ్చినప్పుడు, నా అనుభవం నన్ను మరొక వైపు ఉండటానికి సిద్ధం చేయలేదని నేను గ్రహించాను.

నేను ఇంపాస్టర్ సిండ్రోమ్ యొక్క తీవ్రమైన కేసును అభివృద్ధి చేసాను, ప్రశ్నలతో క్రిందికి తిరుగుతున్నాను: నేను ఈ కోడ్ యొక్క పంక్తిపై వ్యాఖ్యానించాలా లేదా అది విలువైనది కాదా? ప్రతి వ్యాఖ్యకు మద్దతు ఇవ్వడానికి నేను కథనాలను కనుగొనాలా? దీన్ని ఆమోదించడం ద్వారా నేను సైట్‌ను క్రాష్ చేస్తానా? వారు నన్ను ద్వేషిస్తారా? సరే, నేను చాలా త్వరగా మురి అని ఒప్పుకుంటాను. కానీ కొంతమంది సహోద్యోగులతో మాట్లాడిన తరువాత, నా చింతల్లో నేను ఒంటరిగా లేనని నాకు తెలుసు.

జూనియర్ సాఫ్ట్‌వేర్ ఇంజనీర్లను కోడ్ సమీక్షలో "మీకు ఒక పుస్తకాన్ని ఎలా చదవాలో తెలుసు, అందువల్ల ఒక పుస్తకం ఎలా రాయాలో మీకు తెలుసు, ఇది నిజం కాదు" అని సమానమైన with హతో విసిరివేయబడవచ్చు "అని గిట్‌హబ్‌లోని అనుభవ ఇంజనీర్ జెస్సికా రుద్దర్ చెప్పారు.

కోడ్ సమీక్షతో వచ్చే అంచనాలు ఉన్నాయి, మరియు ఈ ప్రక్రియ నరాల ర్యాకింగ్ కావచ్చు. కాబట్టి సమీక్షించే మనస్తత్వాన్ని ఎలా నిర్మించాలో చిట్కాలను సేకరించడానికి నేను మరో ఏడుగురు సాఫ్ట్‌వేర్ ఇంజనీర్లను ఇంటర్వ్యూ చేసాను.

కోడ్ సమీక్ష

1. మొత్తం ప్రభావం గురించి ఆలోచించండి

సాధారణంగా, మంచి పుల్ రిక్వెస్ట్ (పిఆర్) కోడ్‌బేస్ యొక్క పరిమిత భాగాన్ని మాత్రమే ప్రభావితం చేస్తుంది. అయినప్పటికీ, పరిమిత పరిధి పెద్ద కోడ్‌బేస్ సందర్భంలో కోడ్ మార్పు గురించి ఆలోచించకుండా నిరోధించకూడదు.

ది మ్యూజ్‌లోని మాజీ పూర్తి-స్టాక్ ఇంజనీర్ మరియు ప్రస్తుత ఫ్రీలాన్స్ సాఫ్ట్‌వేర్ ఇంజనీర్ నిగెల్ మునోజ్, “ఈ మార్పు పెద్ద మరియు చిన్న చిత్రాన్ని ఎలా ప్రభావితం చేస్తుంది” అనే దాని గురించి ఆలోచించమని సమీక్షకుడిని ప్రోత్సహిస్తుంది. పెద్ద చిత్రాన్ని పరిశీలిస్తే ఏదైనా సాంకేతిక రుణాన్ని కనుగొనడం-కోడ్ కోసం చూడండి ఇది పునరావృతమవుతుంది, మాడ్యులర్ కానిది లేదా ఇటీవలి ప్రామాణిక సమావేశాలకు కట్టుబడి ఉండదు-అలాగే కోడ్‌బేస్ యొక్క నిర్మాణానికి సవరణలను విశ్లేషించడం.

హడ్సన్ రివర్ ట్రేడింగ్‌లోని కోర్ డెవలపర్ సామ్ డోనోవ్, “వ్యాఖ్యానించడానికి చాలా పెద్దది లేదా చాలా చిన్నది ఏమీ లేదు. చిన్న మెరుగుదలల సూచనలు కోడ్‌బేస్‌లోని బహుళ భాగాలలో పెద్ద మెరుగుదలలకు దారితీయవచ్చు. ”

కోడ్ సమీక్ష సానుకూల అభిప్రాయాన్ని అందించడానికి మీరు GitHub పై PR వ్యాఖ్యను ఉపయోగించవచ్చు మరియు ఫ్రేమ్‌వర్క్ రియాక్ట్ యొక్క ప్రామాణిక సమావేశాల నుండి కోడ్ ఎక్కడ భిన్నంగా ఉంటుందో సూచించండి.

ఉదాహరణకు, నా స్వంత కోడ్ సమీక్షలలో, రియాక్ట్ కాంపోనెంట్‌లోని కొన్ని లక్షణాలు గందరగోళంగా ఉన్నాయని నాకు ఒక వ్యాఖ్య వచ్చింది, ఇది ఆ భాగం ఎలా ఉపయోగించబడుతుందనే దానిపై విస్తృత ప్రశ్నలకు దారితీసింది. అంతిమంగా, నేను అసలు భాగం నుండి లక్షణాలను తీసివేసి, ప్రతి ఒక్కరి ప్రవర్తనను స్పష్టం చేయడానికి మరియు రెండింటినీ ఎక్కువ ప్రదేశాలలో ఉపయోగించవచ్చని నిర్ధారించడానికి ఒక ప్రత్యేక భాగాన్ని సృష్టించాను.

2. భద్రతను పరిగణించండి

కొన్ని మార్పులు కోడ్‌బేస్ కంటే ఎక్కువగా ప్రభావితం చేస్తాయని మర్చిపోవద్దు. ఒక వినియోగదారు “ఒకరిని వేధించడానికి ఈ వ్యవస్థను ఉపయోగించవచ్చా లేదా సిస్టమ్‌ను దుర్వినియోగం చేయగలరా” అని అంచనా వేయడానికి రుద్దర్ సిఫార్సు చేస్తున్నాడు. ఉదాహరణకు, పుల్ అభ్యర్థనలోని క్రొత్త ఫీచర్‌లో యూజర్ ఎంట్రీ ఉంటే, SQL ఇంజెక్షన్, డేటా యాక్సెస్, క్రాస్-సైట్ స్క్రిప్టింగ్ మరియు ఇతర భద్రతా లోపాలు.

3. బగ్స్‌పై దృష్టి పెట్టండి

మీ తోటి కోడ్ కంట్రిబ్యూటర్లు-వారు ఎంత రోబోటిక్ అనిపించినా-మనుషులు, మరియు మానవులు కార్యాచరణను విచ్ఛిన్నం చేయవచ్చు లేదా మరచిపోవచ్చు. కాబట్టి మీరు “మిగిలిన కోడ్ మాదిరిగానే ప్రాముఖ్యతతో పరీక్షలను సమీక్షించండి” అని నిర్ధారించుకోండి అని టీచర్స్ పే టీచర్స్ వద్ద టెక్ లీడ్ అభిషేక్ పిళ్ళై సలహా ఇస్తున్నారు. "అవి క్రొత్త దోషాలను నిరోధిస్తాయి మరియు భవిష్యత్తులో దీనిపై పనిచేసే ఎవరికైనా డాక్యుమెంటేషన్ యొక్క రూపంగా ఉపయోగపడతాయి."

పరీక్షలను చదవడం మీకు క్రొత్త లక్షణం యొక్క కార్యాచరణను అర్థం చేసుకోవడంలో సహాయపడుతుంది మరియు ఇది ప్రవేశపెట్టే వివిధ సందర్భాలను చూడవచ్చు, పరీక్షలను విశ్లేషించడం తప్పిపోయిన కేసులను ఎత్తిచూపడానికి మరియు ఈ PR లో లేని లక్షణాలను కనుగొనడంలో మీకు సహాయపడుతుంది. కోడ్ మార్పులో పరీక్షలు ఏవీ లేనట్లయితే మరియు అవి సంబంధితంగా అనిపిస్తే, వాటిని సమీక్షలో అభ్యర్థించడం సముచితం.

కానీ పరీక్షలు ప్రతిదీ కాదు. "వ్యవస్థపై ఎక్కువ నమ్మకం ఉంచవద్దు" అని డోనో హెచ్చరించాడు. "పరీక్షలు నడిచినందున దోషాలు లేవని కాదు."

మీరు “అనువర్తనాన్ని క్రియాత్మకంగా పరీక్షించడానికి మరియు అది పనిచేస్తుందని నిర్ధారించుకోవడానికి స్థానికంగా దీన్ని అమలు చేయాలనుకోవచ్చు. ఇది పని చేయకపోతే, మరింత సమీక్షించడంలో అర్థం లేదు ”అని 8 వ లైట్ వద్ద సాఫ్ట్‌వేర్ డెవలపర్ అయిన ర్యాన్ వెర్నర్ చెప్పారు. కొంతమంది సమీక్షకులు మాన్యువల్ టెస్టింగ్ కోడ్ సమీక్ష ప్రక్రియలో భాగం కావాలని అనుకోకపోయినా-కొంత సమయం పడుతుంది-మీరు ఎక్కువ సమయం సమీక్షించడాన్ని మరియు తగ్గించడానికి సహాయపడే వ్యూహాన్ని పెట్టుబడి పెట్టాలా అని నిర్ణయించడానికి ఇది శీఘ్ర మార్గం అని వెర్నర్ అభిప్రాయపడ్డారు. బగ్స్ బ్యాక్‌లాగ్ యొక్క పెరుగుదల.

4. టీమ్ ప్లేయర్‌గా ఉండండి

కోడ్‌ను సమీక్షించేటప్పుడు క్లిచ్ కొత్త అర్థాన్ని పొందుతుంది. “సమిష్టి యాజమాన్యం” అనే భావన కోసం వాదించే వెర్నెర్, “ఇది ప్రతి ఒక్కరి కోడ్‌బేస్” అని సమీక్షించడానికి సమయాన్ని వెచ్చించండి. సమీక్షకుడిగా మీరు, దోషాల బ్యాక్‌లాగ్‌ను పెద్దగా పెరగకుండా రక్షించే దిశగా పని చేయాలి. జట్టు తక్కువ పని చేస్తుంది.

కోడ్ సమీక్ష పిళ్ళై తన సహచరుల ఆమోదం పొందిన మరియు విలీనం చేయడానికి సిద్ధంగా ఉన్న పిఆర్‌లను జరుపుకోవడానికి జిఫ్‌లను ఉపయోగిస్తాడు.

అదే సమయంలో, ది మ్యూజ్‌లో టెక్ లీడ్ అయిన చార్లెస్ లుక్స్టన్, జట్టు యొక్క ప్రాధాన్యతలను అర్థం చేసుకోవడానికి మరియు గుర్తుంచుకోవడానికి సమీక్షకుడిని ప్రోత్సహిస్తాడు. వేగంగా సమీపించే గడువులు మరియు విభేదాలు పుష్కలంగా ఉండటంతో, కొన్నిసార్లు మెరుగుదలలు జరుగుతాయని నిర్ధారించే బ్యాక్‌లాగ్ కోసం చేయవలసిన వస్తువును సృష్టించడం మరియు ఈ సమయంలో ప్రశ్నార్థకమైన కోడ్‌పై వ్యాఖ్యానించడం మీకు అవసరమైన బ్యాండ్-ఎయిడ్ మీ బృందాన్ని సంతోషంగా ఉంచండి.

చివరగా, జట్టులో చేరిన మరియు వారి మొదటి కొన్ని వారాల్లోనే చదివేవారికి ఈ కోడ్ అర్ధమవుతుందా అని మీరే ప్రశ్నించుకోవడం మీ కోడ్‌ను చదవగలిగేలా మరియు అర్థమయ్యేలా ఉంచడానికి సహాయపడుతుంది.

5. అభ్యాసం మరియు జ్ఞాన భాగస్వామ్యం కోసం ప్రక్రియను ఉపయోగించండి

సమీక్షా విధానం ప్రమేయం ఉన్న ప్రతి ఒక్కరికి కోడ్‌బేస్, భాషలు, ఫ్రేమ్‌వర్క్‌లు మరియు ఉత్తమ అభ్యాసాల గురించి మరింత అవగాహన కల్పించడానికి ఒక స్థలాన్ని ఇస్తుంది.

ది మ్యూజ్‌లో టెక్ లీడ్ అయిన మాట్ జెఫరీ, సమీక్షకుడికి "మార్పులను నిర్మాణపరంగా అర్థం చేసుకోవాలని సలహా ఇస్తున్నారు. సందర్భం ఇవ్వడానికి సహాయపడటం వలన ఫైల్ పేర్లను చదవడం ఒక మార్గం. ఉదాహరణకు, మీరు డేటా యాక్సెస్ లేయర్‌లో మార్పును చూస్తున్నట్లయితే మీరు వ్యాపార తర్కం లేదా UI తో వ్యవహరించడం లేదని మీకు తెలుసు. "

కోడ్ సమీక్ష డాక్యుమెంటేషన్‌ను భాగస్వామ్యం చేయడానికి మీరు GitHub లో PR వ్యాఖ్యను ఉపయోగించవచ్చు.

మీరు కోడ్ మార్పుల నుండి నేర్చుకున్నప్పుడు, మీకు జ్ఞానాన్ని పంచుకునే అవకాశం కూడా ఉంటుంది. "మీ అభిప్రాయాన్ని వివరించడం మరియు డాక్యుమెంటేషన్‌తో బ్యాకప్ చేయడం ఉత్తమం" అని లుక్స్టన్ చెప్పారు. సహాయక సాక్ష్యాలు మరియు నమ్మదగిన కథనాలకు మీరు అందించే లింకులు సమీక్షకుడు మరియు కోడ్ రచయిత తుది నిర్ణయం తీసుకునేటప్పుడు విభిన్న విధానాలను అన్వేషించడంలో సహాయపడటమే కాకుండా, ప్రోగ్రామింగ్ గురించి వారి జ్ఞానాన్ని పెంచుతాయి.

మీరు ఈ చిట్కాలను గుర్తుంచుకునేటప్పుడు, సమీక్షించడం అనేది మీ వ్యక్తుల నైపుణ్యాలను వ్యాయామం చేసే సమయం అని గుర్తుంచుకోండి. "ప్రజలు తమ విధానం గురించి ఆలోచించిన సందేహం యొక్క ప్రయోజనాన్ని ఇవ్వండి మరియు రక్షణాత్మకతను తొలగించడానికి ప్రయత్నిస్తున్నప్పుడు విభిన్న అవకాశాలను ఎత్తి చూపుతారు" అని రుద్దర్ చెప్పారు. "నేను అంతటా వ్యాఖ్యలను మరియు వ్రాప్ అప్ వ్యాఖ్యను ఇస్తున్నాను-ఇక్కడ గొప్పది ఏమిటి, ఇక్కడ మెరుగుపరచగలిగేది ఇక్కడ ఉంది, విలీనం చేయడానికి ముందు ఏమి మార్చాలి."

ఈ విధమైన విధానంతో, మీరు మీ కోడ్ బేస్ ను టెక్ debt ణం, భద్రతా బెదిరింపులు మరియు దోషాల నుండి రక్షించడమే కాకుండా, మీరు మీ బృందాన్ని కూడా నిర్మిస్తారు.