Hh.ru में कोड समीक्षा की प्रक्रिया

मुझे कंपनी के भीतर कोड समीक्षा की प्रक्रिया के नियमों और सिफारिशों के साथ एक दस्तावेज मिला। मैंने तय किया कि इस तरह की उपयोगी जानकारी को बाहरी दुनिया के साथ साझा किया जाना चाहिए। लेखक के आशीर्वाद से , मैं काम प्रकाशित करता हूं।



इन नियमों में से अधिकांश प्रकृति में सलाहकार हैं और मुख्य रूप से सामान्य ज्ञान द्वारा निर्देशित होना चाहिए, न कि अंधा पालन।

• सामान्य प्रावधान
• उद्देश्यों की समीक्षा करें
• समीक्षा की तैयारी
• समीक्षक की पसंद
• समीक्षा प्रक्रिया, सामान्य
• कोड लेखक द्वारा समीक्षा प्रक्रिया
• समीक्षक द्वारा समीक्षा प्रक्रिया
• प्रयुक्त सामग्री और संबंधित लिंक

सामान्य प्रावधान

• Hh.ru में, समीक्षा Github पर पुल अनुरोध प्रारूप में होती है।
• समीक्षा और पुल अनुरोधों की आवश्यकता होती है, भले ही कार्य के ढांचे के भीतर कोड में एक पंक्ति या एक चरित्र को बदल दिया जाए।
• प्रत्येक कार्य में कम से कम एक जिम्मेदार समीक्षक होना चाहिए, यह कार्य में समीक्षक के रूप में इंगित किया गया है और लेखक के समान कोड के लिए जिम्मेदार है। अन्य लोगों की समीक्षा में भाग लेने के लिए निषिद्ध और प्रोत्साहित नहीं किया गया।
• समीक्षा के माध्यम से कार्य के संचालन की जिम्मेदारी कार्य के लेखक के पास है।
• समीक्षा के बाद कोई भी बदलाव, जैसे परीक्षण के दौरान संशोधन, का भी पूर्वावलोकन किया जाना चाहिए।

उद्देश्यों की समीक्षा करें

• डेवलपर्स के बीच अनुभव और ज्ञान का प्रसार।
• सिद्धांत के लिए समर्थन - परिवर्तन मौजूदा कोड को खराब नहीं करना चाहिए, उन्हें इसमें सुधार करना चाहिए।
• तर्क में त्रुटियों और सुरक्षा से संबंधित त्रुटियों का सुधार, अपवादों को सही ढंग से संभालना।
• कोड की गुणवत्ता में सुधार, स्थिरता और परियोजना की वास्तुकला।
• कोड पठनीयता में सुधार।
• परीक्षण कवरेज में सुधार और सही स्तर पर परीक्षण।
• प्रलेखन में सुधार।
• कार्य में आवश्यकताओं के साथ परिवर्तनों का अनुपालन।
• से बचाव तकनीकी ऋण या रखरखाव कर।
• एपीआई का विचारशील डिजाइन, जहां एपीआई बाहरी इंटरफ़ेस वाला कोई भी मॉड्यूल है। उदाहरण के लिए, कि किसी सेवा में संसाधन में एक सुविचारित URL, एक सुविधाजनक JSON प्रारूप, विभिन्न मामलों में सही प्रतिक्रिया कोड, और इसी तरह है।
• गीता में कमिट का सही इतिहास, उन संदेशों के साथ है, जो बिना किसी अस्थायी संदेश के संदेश के सार को दर्शाते हैं।

समीक्षा की तैयारी

• पुल अनुरोध को प्रकाशित करने से पहले, अपने कोड को 2-3 बार पढ़ें: एक उच्च संभावना के साथ, आप स्वयं वहां त्रुटियां पाएंगे, जो समीक्षक के लिए समय बचाएगा। जांचें कि ऐसी कोई त्रुटि नहीं है जो स्वचालित रूप से पता लगाया जा सकता है - कोड-शैली की त्रुटियां, गिराए गए परीक्षण। सुनिश्चित करें कि कोड में कोई अस्थायी टिप्पणी और डिबगिंग कोड नहीं है, और यह भी जांचें कि आपका कोड स्वीकृत स्टाइल गाइड से मेल खाता है या नहीं।
• यदि आप किसी कार्य को करने की प्रक्रिया में एक पुल अनुरोध बनाते हैं, तो शीर्षक में "[WIP]" लिखें और "कार्य प्रगति पर" चिह्न लगाएं। जब काम समाप्त हो जाता है, तो टैग हटा दें और इसके बारे में एक अलग टिप्पणी में सूचित करें ताकि इच्छुक पार्टियों को पता चले कि कोड को देखा जा सकता है।
• समीक्षक को कार्य पर एक मिनी डेमो दिखाने के लिए तैयार रहें।
• समीक्षा के लिए कोड के छोटे हिस्से दें। परिवर्तन की 200-300 लाइनें - एक प्रभावी समीक्षा के लिए सीमा।
• अलग-अलग कमिट में स्वतंत्र बदलाव करें।
• लघु और सूचनात्मक संदेशों के साथ कमिट करें।
• एक अलग वचनबद्धता के रूप में कार्य करना, तर्क में परिवर्तन, कार्य का सार देखना आसान है।
• बड़े बदलावों से पहले एक अलग कमिट के रूप में या एक अलग पुल अनुरोध के रूप में कोड को प्रारूपित करें।
• छोटे-मोटे बदलाव न करें। उदाहरण के लिए, एक फ़ाइल में लाइन ब्रेक जोड़ना जिसमें आपने कुछ और नहीं बदला।
• पुल अनुरोध के शीर्षक में, संक्षेप में और जानकारीपूर्ण रूप से परिवर्तनों का सार वर्णन किया गया है।
• पुल अनुरोध में समस्या और समाधान का वर्णन करें। वैकल्पिक समाधानों का वर्णन करें और वर्तमान समाधान का चयन क्यों किया जाता है। यदि परिवर्तन इंटरफ़ेस से संबंधित हैं, तो स्क्रीनशॉट को "पहले" और "बाद में" संलग्न करें।
• पुल अनुरोध में, कार्य के लिए एक लिंक दें, और कार्य में पुल अनुरोध के लिए एक लिंक दें।
• कोड लिखने से पहले समीक्षक के साथ चुने गए समाधान पर चर्चा करना कभी-कभी उपयोगी होता है। यह समस्या का सबसे अच्छा समाधान खोजने और समीक्षा प्रक्रिया को सरल बनाने में मदद करेगा।

समीक्षक की पसंद

• संबंधित क्षेत्र के विशेषज्ञ को समीक्षा का कार्य दें।
• यदि कई कमांड कुछ कोड के साथ काम करते हैं, तो ज्ञान फैलाने के लिए किसी अन्य टीम से समीक्षक का चयन करना उपयोगी है।
• परिवीक्षा अधिकारी जिम्मेदार समीक्षक नहीं हो सकता है, लेकिन समीक्षा प्रक्रिया में भाग ले सकता है।
• एक ही लोगों को अपने सभी कार्यों की समीक्षा न दें - विभिन्न लोगों से समीक्षा के लिए पूछें।
• यदि समस्या में एक गैर-तुच्छ टुकड़ा शामिल है जिसे एक निश्चित व्यक्ति समझता है, तो उसे परिवर्तन दिखाएं, चाहे कोई भी जिम्मेदार समीक्षक हो। यह भी याद रखें कि प्रत्येक रिपॉजिटरी में अनुचर होते हैं, वे इस कोड के बारे में अधिक जानते हैं और विकास की देखरेख करते हैं।
• बाकी समीक्षक को पार्टियों के आपसी समझौते द्वारा मनमाने ढंग से चुना जाता है। आपको चुनने में मदद करने के लिए प्रभावित कोड के "दोष" के आधार पर गिटब पर सिफारिशों का उपयोग करें।
• एक समीक्षक का चयन करने के बाद, इसे पुल अनुरोध में एक असाइन के रूप में निर्दिष्ट करें। आपके लिए असाइन किए गए सभी पुल अनुरोधों की एक सूची ।

समीक्षा प्रक्रिया, सामान्य

कोड के लेखक और समीक्षक दोनों को संदर्भित करता है।

• सभी कोड आम हैं, "मेरा कोड" या "आपका कोड" जैसी कोई अवधारणा नहीं है। इसका मतलब यह है कि हर डेवलपर कोड की किसी भी लाइन के लिए ज़िम्मेदार है, न कि जिसने इस लाइन को लिखा है।
• आपसी समझ का माहौल बनाएं, विनम्र और मित्रवत रहें, एक दूसरे का मूल्य और सम्मान करें, अपनी राय न थोपें। प्रतिद्वंद्वी की राय सुनें और अपने सिद्धांत की जमीन खड़ी न करें। सहकर्मियों के लिए समीक्षा को नकारात्मक अनुभव में न बदलें।
• कुछ स्पष्ट न होने पर प्रश्न पूछें। तर्क और सवाल और जवाब निर्दिष्ट करें। यह कोड के लेखक के लिए स्पष्ट नहीं हो सकता है कि प्रश्न का अर्थ "ऐसा क्यों है?" है, लेकिन समीक्षक उत्तर "असहमत" के तर्क को नहीं समझता है।
• समीक्षा प्रक्रिया को लंबा न करें, समय की बचत करें, जल्दी से टिप्पणियों का जवाब दें, मौखिक रूप से चर्चा करें, लंबी चर्चा को उत्तेजित न करें और "होलिवर्स" को न करें। यदि आप जल्दी से आम सहमति तक नहीं पहुंच सकते हैं, तो अपने सहयोगियों, अनुचर, या कार्यात्मक क्षेत्र के प्रबंधक से मदद लें।
• यदि कार्य कुछ पंक्तियों में नहीं है, तो एक संयुक्त कोड समीक्षा पर समीक्षक के साथ 10-15 मिनट बिताएं, पुल अनुरोध बनाने से पहले भी ऐसा करना उपयोगी है। कार्य और समाधान के सार पर चर्चा करें, देखें कि यह कैसे था और काम के माहौल में बन गया। इससे समीक्षक को कार्य के संदर्भ में बेहतर गोता लगाने में मदद मिलेगी। अधिकांश टिप्पणियां अलिखित रहेंगी, जिससे सभी का समय बचेगा।
• मौखिक चर्चा के बाद, हमेशा किए गए निर्णय और पुल अनुरोध में इसके कारणों का वर्णन करें। विवरण की जिम्मेदारी कोड के लेखक के पास है।
• यदि कोड में एक ही प्रकार की त्रुटियां हैं, तो समीक्षक को पहली या दूसरी टिप्पणी में कोड के लेखक के ध्यान पर ध्यान केंद्रित करना चाहिए, प्रत्येक प्रविष्टि पर टिप्पणी नहीं करनी चाहिए, और लेखक को सुधार को प्रकाशित करने से पहले उसी प्रकार की त्रुटियों के लिए कोड का विश्लेषण करना चाहिए।
• लेखक के सफल निर्णयों और समीक्षक के सुझावों की प्रशंसा करें।
• पुल अनुरोध में परिवर्तन पर टिप्पणी छोड़ें, न कि व्यक्तिगत कमिट पर। इस प्रकार, सभी पत्राचार एक स्थान पर होगा, जिसमें छूट के बाद भी शामिल होगा।
• उन्हीं चर्चा सूत्र में टिप्पणियों का जवाब दें जहां उन्होंने शुरू किया था। यदि टिप्पणी पूरे पुल अनुरोध या एक ही धागे में कई टिप्पणियों को संदर्भित करती है, तो टिप्पणी की गई टिप्पणी को उद्धृत करें। ईमेल से किसी पुरानी चर्चा सूत्र में जाने के लिए, "इसे GitHub पर देखें" लिंक के बजाय, "पथ / / से फ़ाइल" लिंक का उपयोग करें।
• यदि समीक्षा प्रक्रिया के दौरान कोई भी कार्डिनल निर्णय कोडिंग मानकों या अन्य औपचारिक समझौतों के दृष्टिकोण से किया जाता है, तो कोड के लेखक को संबंधित दस्तावेजों में इन निर्णयों को लिखने के लिए बाध्य किया जाता है।
• समीक्षा केवल कोड के बारे में नहीं है, बल्कि पूरे कार्य के बारे में है। कार्य या लेआउट में आवश्यकताओं को अंतिम सत्य के रूप में न मानें - हर कोई गलती करता है और कोई भी सभी बारीकियों को ध्यान में नहीं रख सकता है। एक ताज़ा नज़र और समझदार सुझाव केवल उत्पाद को लाभान्वित करेंगे।

कोड लेखक द्वारा समीक्षा प्रक्रिया

• कार्य तब तक पूरा नहीं हुआ, जब तक कि वह "ठेस" पर समीक्षा, परीक्षण और रिलीज से गुजर नहीं गया।
• समीक्षक की सभी टिप्पणियों का जवाब दें, टिप्पणियों को अनुत्तरित न छोड़ें, भले ही आपने उन्हें स्वीकार किया हो या नहीं।
• उन प्रश्नों के बारे में सोचें जो समीक्षा के दौरान उत्पन्न होते हैं या हो सकते हैं। शायद कोड अनुभाग एक टिप्पणी याद कर रहा है, या कोड को अधिक स्पष्ट रूप से लिखा गया है।
• एक जेंडर कमिटमेंट के साथ मौजूदा कमिट्स को सही न करें - इसके बजाय, अलग-अलग कमिट के रूप में बदलाव करें, प्रत्येक फिक्स के लिए एक। मौजूदा कमियों को ठीक करना समीक्षा प्रक्रिया को बहुत जटिल करता है, क्योंकि आपको फिर से सभी कोड को देखना होगा।
• पुल अनुरोध में एक नई प्रतिबद्धता जोड़ने के बाद, एक अलग टिप्पणी में परिवर्तनों का सारांश लिखें ताकि इच्छुक पार्टियों को पता चल सके। यह समीक्षा के दौरान सुधारों पर लागू होता है, साथ ही परीक्षण के दौरान सुधार पर भी लागू होता है।
• समीक्षा के बाद, परीक्षण के लिए कार्य भेजने से पहले, कमिट्स के इतिहास को फिर से लिखना (git rebase --interactive), व्यक्तिगत कमेंट्स को सही बनाता है और अस्थायी कमिट्स को हटाता है। प्रक्रिया को सरल बनाने के लिए --autosquash विकल्प देखें।

समीक्षक द्वारा समीक्षा प्रक्रिया

• यदि आप समीक्षा के अनुरोध के समय व्यस्त हैं, तो मुझे ठीक से बताएं कि आप समीक्षा कब शुरू करेंगे।
• मांग न करें, लेकिन बदलाव करने का सुझाव दें।
• कोड पर टिप्पणी करें, उस व्यक्ति पर नहीं जिसने इसे लिखा था।
• आप लिखित कोड की जिम्मेदारी लेते हैं, उसके अनुसार समीक्षा करते हैं, लेकिन इसका मतलब यह नहीं है कि कोड के लेखक को आपकी सभी आवश्यकताओं का सख्ती से पालन करना चाहिए। याद रखें, कई चीजें अलग-अलग तरीकों से की जा सकती हैं।
• समीक्षा के लक्ष्यों का पालन ​​करें और पर्याप्त संपादन का सुझाव दें। गैर-महत्वपूर्ण परिवर्तनों पर जोर न दें। एक टिप्पणी में सुधार के महत्व को इंगित करें।
• यदि आप एक गंभीर समस्या पाते हैं, तो समीक्षा को रोकें और लेखक को इसे ठीक करने के लिए प्रतीक्षा करें। सबसे अधिक संभावना है, सुधार के बाद भी फिर से संशोधन करना आवश्यक होगा।
• न केवल जो बदला गया है, उस पर ध्यान दें, बल्कि जो बदला नहीं गया है, उस पर भी ध्यान दें। लेखक को उस कोड को देखें और दिखाएं, जिसे बदल दिया जाना चाहिए था, लेकिन नहीं था (भूल गए आयात या अप्रयुक्त वर्गों, रिफैक्ट किए गए कोड का उपयोग करके कहीं और, आदि)।
• कोड लेखक द्वारा परिवर्तन करने के बाद, सुधारों की समीक्षा करें और फिर से पूरे पुल अनुरोध की समीक्षा करें। शायद, सुधार के अधीन, आपके पास नई टिप्पणियाँ या प्रश्न होंगे।
• उस समय की समीक्षा कोड को बर्बाद न करें जो कार्य के हिस्से के रूप में नहीं बदला है। किसी फ़ंक्शन में कोड के एक हिस्से का आवंटन एक बदलाव माना जाता है। "जैसा है" कोड ट्रांसफर को बदलाव नहीं माना जाता है। प्रभावित फ़ाइल में कोड का सुधार लेखक के विवेक पर है।
• समीक्षक शाखा में कोड को स्वतंत्र रूप से संपादित नहीं करता है, क्योंकि वह इसे बहुत अधिक या आसान चाहता है। कोड के लेखक द्वारा परिवर्तन किए जाते हैं।
• यदि आपने एक संशोधन किया है, तो वर्तमान के अवरोध के लिए अन्य कार्यों में देरी या स्विच न करने का प्रयास करें

प्रयुक्त सामग्री और संबंधित लिंक

• केविन लंदन द्वारा कोड रिव्यू बेस्ट प्रैक्टिस
• कोड की समीक्षा क्यों मायने रखती है? एंटोन कुज़नेत्सोव से
• कोड समीक्षा आमिर यासीन द्वारा अपनी टीम बना या तोड़ सकते हैं
• मार्को ट्रॉसी द्वारा आचार संहिता समीक्षा
• रॉबर्ट बॉग द्वारा प्रभावी कोड समीक्षा दर्द के बिना
• एमडीएन - मार्किया नूस और अन्य से कोड समीक्षा FAQ
• कैसे एक अच्छा पुल अनुरोध बनाने के लिए
• एक अच्छा कोड समीक्षा कैसे करें
• शीर्ष दस पुल अनुरोध की समीक्षा गलतियों स्कॉट Noneberga द्वारा
• सीन हैमंड द्वारा दूरस्थ टीमों में कोड की समीक्षा
• हो सकता है कि कोड की समीक्षा आपके साथ येओगोर टॉल्स्टॉय करें
• कैसे मैं इवान Baranov द्वारा हेडहंटर में दुनिया को बेहतर बनाने के लिए सीखा

PS टिप्पणियों में समीक्षा प्रक्रिया पर अपने नियमों, सिफारिशों और उपयोगी उपयोगकर्ता मामलों को साझा करें