यैंडेक्स से डेवलपर से उपयोगी कोड समीक्षा के लिए नुस्खा

नमस्कार। मेरा नाम सर्गेई है, मैं पिछले पांच वर्षों से यैंडेक्स में काम कर रहा हूं। इस दौरान उन्होंने ग्यारह परियोजनाओं के विकास में भाग लिया। उन्होंने जावास्क्रिप्ट, पायथन और C ++ में कोड लिखा। उन्होंने अकेले कुछ प्रोजेक्ट किए, अन्य उन्होंने आठ लोगों के समूह में विकसित किए। लेकिन प्रत्येक टीम में, सभी परियोजनाओं पर, प्रोग्रामिंग भाषा की परवाह किए बिना, मैंने एक कोड समीक्षा का उपयोग किया।

एक कोड समीक्षा की मदद से, मैं लगातार कुछ नया सीखता हूं। कभी-कभी, किसी और के कोड को देखकर, मैं बहाना चाहता हूं: "लेकिन क्या, यह भी संभव है?"। किसी और के कोड में, मैं दिलचस्प ट्रिक्स ढूंढता हूं और उन्हें सेवा में ले जाता हूं। मैं अपने कोड पर टिप्पणियों से कई नए ज्ञान प्राप्त करता हूं। यह मेरे लिए एक खोज थी कि लोग अपने अनुभवों को साझा करना पसंद करते हैं। यहां तक ​​कि जब मैं अकेले एक परियोजना विकसित कर रहा हूं, तो मैं दूसरी टीम के लोगों से अपनी पुल-क्वैस्ट देखने के लिए कहता हूं। यह सुंदर और स्पष्ट कोड लिखने के लिए प्रेरित करता है।

लेकिन हमेशा ऐसा नहीं था। एक बार एक समीक्षा मेरे लिए एक सजा थी। मैं एक हफ्ते के लिए प्रेरणा के साथ कोड लिख सकता था, अपनी सारी शक्ति इसमें लगा दी। मैंने समीक्षक को तीन बार पिंग किया, और बदले में एक सूखा "ओके" या, इससे भी बदतर, दर्जनों टिप्पणियां प्राप्त की, जो योग्यता पर नहीं थी।

पाँच हज़ार लाइनों के पूल मेरी समीक्षा में आए। मैंने घंटों कोड को जानने की कोशिश की, फ़ंक्शन से परीक्षण और इसके विपरीत सौ बार स्क्रॉल किया। उन्होंने लापता अर्धविराम के बारे में दर्जनों बेकार टिप्पणियां लिखीं। इस सबने मुझे बहुत परेशान किया। अक्सर मैंने बाद के लिए समीक्षा को बंद कर दिया, और मैंने दर्जनों अनारक्षित पूल जमा किए।

अगर आपको यह खुद पर लगा है, तो लेख आपके लिए है। आज मैं उन तकनीकों और उपकरणों के बारे में बात करूँगा जो मैं हर दिन पांच साल के दैनिक कोड समीक्षा के लिए उपयोग करता हूं।

"समीक्षा से पहले।" लेखक के लिए टिप्स

कल्पना कीजिए कि समस्या का समाधान खाना बनाना है। आप एक टीम के रूप में काम करते हैं, इसलिए आपको न केवल खाना बनाना है, बल्कि अन्य शेफ भी सिखाना है। उन्हें परिणाम दिखाने के लिए पर्याप्त नहीं है, आपको नुस्खा लिखने की आवश्यकता है।

प्रतिबद्ध

नुस्खा का प्रत्येक चरण एक प्रतिबद्ध है: उन्होंने दो अंडे तोड़ दिए - उन्हें बनाया, एक गिलास दूध जोड़ा - उन्हें बनाया, दो सौ ग्राम आटा डाला - उन्हें फिर से बनाया।

प्रत्येक प्रतिबद्ध में, मैं एक सरल विचार व्यक्त करता हूं। यह एक लेआउट में एक मॉडल विधि या घटकों का कार्यान्वयन हो सकता है। इसलिए समीक्षक के लिए मुझे समझना आसान हो जाएगा। मैं इसे पूरे कार्य पर दोष नहीं देता, जिसे एक समय में निगला नहीं जा सकता, लेकिन टुकड़ों में समाधान के बारे में बताएं।

मैं अलग कमिटमेंट में कोई भी रिफैक्टिंग निकालता हूं। अक्सर, refactoring प्रकृति में विशुद्ध रूप से तकनीकी है, उदाहरण के लिए, एक विधि का नाम बदलकर। समीक्षक को इस तरह के बदलाव की हर पंक्ति को पढ़ने की आवश्यकता नहीं है। वह अपनी आँखें "तिरछे" चलाएगा और अधिक महत्वपूर्ण कोड के लिए अधिक समय समर्पित कर सकेगा।

टुकड़े टुकड़े करना, लूटना, अपने कोड को छोटे कमिट में काटें। इससे समीक्षक आपके कोड को बेहतर ढंग से समझ पाएंगे। यदि आप अपघटन के साथ ओवरबोर्ड जाते हैं तो यह ठीक है। दो कमिट एक में संयोजित करना आसान है। एक बड़ी प्रतिबद्ध को कई छोटे लोगों में विभाजित करना अधिक कठिन है। "कटा हुआ सब्जियां" आसानी से "कटा हुआ टमाटर" और "कटा हुआ प्याज" मिलाकर प्राप्त किया जाता है। लेकिन एक सलाद प्लेट से भागों में सभी सामग्री प्राप्त करने के लिए, आपको बहुत अधिक समय बिताने की आवश्यकता है।

कमिट करने के बाद, मैं तुरंत गीथूब में बदलाव को धक्का देता हूं। इसने मुझे कई बार मदद की जब एक लैपटॉप के साथ "कॉफी की परेशानी" थी।

कमिट्स का विवरण

जब मैं एक ईमेल लिखता हूं, तो मैं पत्र के हेडर और सामग्री को भर देता हूं। शीर्षक एक छोटा और कैपेसिटिव नाम है, अक्षर का शरीर चित्रों और लिंक के साथ एक विस्तृत, विस्तृत विवरण है। मैं कमिट्स के विवरण के लिए एक ही दृष्टिकोण लागू करता हूं।

git commit -m 'fix1'. git commit, . ( ). ( ).

, " " " ". , . . ASCII- . , , .

( ASCII-)

( . vim)

( GitHub. )

, , . :

git status
git diff comments.js
git add comments.js

, . git add ., . , .

. , . JavaScript ESlint. R2-D2 " ", . , , .

WebStorm " ". , , . husky.

. . .

( )

– , – . , . git log --pretty='%h: %B' --first-parent --no-merges --reverse.

( `git log --pretty='%h: %B' --first-parent --no-merges --reverse`)

( , )

, . , . .

! , .

« ».

– , .

, . , , . , . , " ".

. . .

–

. ! . , . , , . , .

. , . .

. :

function sum(arr) {
  return arr.reduce(function (res, i) {
    return res + i;
  }, 0);
}

sum([1, 2, 3]); // 6

, :

const sum = arr => arr.reduce((res, i) => res + i);

, . , , . , . – .

Offline

, . , . .

offline-. (, : , ), .

. -, . -, : ( ). -, , — .

, . offline- .

« ».

, . . .

, . , , , . , : ? ? ? , .

. , .

( : )

. , . ? ' , .

-. . , . , , .

git rebase --interactive master. , FEATURE-1, master — . , , pick squash. .

( , )

--force. , . git push origin FEATURE-1 --force , . , .

GitHub. "Squash and merge".

( GitHub)

, . FEATURE-1. :

git checkout master
git pull origin master
git branch -D FEATURE-1

( .)

, , :

#     
git checkout -b FEATURE-1

#  
git status
git diff src/controllers/v1/comments.js
git add src/controllers/v1/comments.js

#    
git commit
git push origin FEATURE-1

#    
git log --pretty='%h: %B' --first-parent --no-merges --reverse

#    
git rebase --interactive master
git push origin FEATURE-1 --force

#  
git checkout master
git pull origin master
git branch -D FEATURE-1

#  ,      
git add comment.js

#    
git commit --amend