मेरा पसंदीदा git कमिट

लगभग। ट्रांस। : एक ब्रिटिश प्रोग्रामर का यह प्रकाशन, जो अंग्रेजी बोलने वाले इंटरनेट पर एक वास्तविक हिट बन गया है, 6 साल पहले एक Git कमिट को संदर्भित करता है। यह सरकारी डिजिटल सेवा ओपन रिपॉजिटरी में से एक में दर्ज किया गया था - यूके में डिजिटल सेवाओं के विकास और GOV.UK परियोजना का समर्थन करने के लिए समर्पित सेवा। अपने आप में यह दिलचस्प है कि कोड में बदलाव के साथ इतना दिलचस्प नहीं है जितना कि विवरण के साथ ...


Xkcd # 1296 से छवि

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

जब मैंने गवर्नमेंट डिजिटल सर्विस में काम किया था, तब यह कमिट किया गया था। इसका लेखक डैन कार्ले नाम का एक डेवलपर है, और इसमें एक बहुत ही नामुमकिन शीर्षक है: " त्रुटि को ठीक करने के लिए टेम्पलेट को US-ASCII में रूपांतरित किया ।"

“मैंने` / etc / nginx / router_routes.conf` की सामग्री से मेल करने के लिए फीचर शाखा में कई परीक्षण लागू किए हैं। वे अच्छी तरह से काम करते हैं यदि कमांड के साथ चलते हैं 'बंडल एग्जाम्पल रेक स्पेक' या 'बंडल एक्जीक्यूट आरएसपीईसी मॉड्यूल / राउटर / स्पेक'। लेकिन जब r बंडल एग्जाम रेक ’को चलाया जाता है, तो प्रत्येक ब्लॉक को विफल होना चाहिए:

ArgumentError: invalid byte sequence in US-ASCII 

अंत में, मैंने पाया कि `.with_content (//)` की अभिव्यक्ति के अपवाद के बाद, सभी त्रुटियां दूर हो जाती हैं। कि विनिर्देश फ़ाइल में कोई अजीब अक्षर नहीं हैं। और यह भी कि इसे उसी दुभाषिया में कठपुतली कहकर खेला जा सकता है:

  rake -E 'require "puppet"' spec 

यह टेम्प्लेट हमारे कोडबेस की एकमात्र फ़ाइल लगती है जो 'utf-8' के साथ एन्कोडेड है। 'Us-ascii' में अन्य सभी फाइलें:

  dcarley-MBA:puppet dcarley$ find modules -type f -exec file --mime {} \+ | grep utf modules/router/templates/routes.conf.erb: text/plain; charset=utf-8 

अंतरिक्ष की तरह दिखने वाले एकल चरित्र के कारण इसे US-ASCII में ट्रांसकोड करने का प्रयास विफल रहा:

  dcarley-MBA:puppet dcarley$ iconv -f UTF8 -t US-ASCII modules/router/templates/routes.conf.erb 2>&1 | tail -n5 proxy_intercept_errors off; # Set proxy timeout to 50 seconds as a quick fix for problems # iconv: modules/router/templates/routes.conf.erb:458:3: cannot convert 

इसे (मैन्युअल रूप से) बदलने के बाद फ़ाइल फिर से 'US-ASCII' बन गई:

  dcarley-MBA:puppet dcarley$ file --mime modules/router/templates/routes.conf.erb modules/router/templates/routes.conf.erb: text/plain; charset=us-ascii 

अब परीक्षण काम करते हैं! मेरे जीवन का पूरा एक घंटा नहीं लौटाया जा सकता ... "

एक छोटा विषयांतर: जीडीएस में प्रचलित ओपन सोर्स डेवलपमेंट का एक लाभ यह है कि आप इसे बनाने वाले संगठन के बाहर के उदाहरणों को साझा कर सकते हैं। मुझे नहीं पता कि GDS में पहली बार इस अवधारणा को किसने प्रस्तावित किया था - जब तक मैं संगठन में शामिल हुआ, तब तक यह पहले से ही व्यापक रूप से इस्तेमाल किया गया था - लेकिन मैं इस व्यक्ति के लिए असीम रूप से आभारी हूं।

मुझे यह क्यों पसंद है

अनगिनत बार मैंने इसे उदाहरण के रूप में उद्धृत किया है कि क्या प्रतिबद्धताओं में सक्षम हैं। यह कोड में परिवर्तन और विवरण के आकार के कारण कुछ हद तक मज़ेदार है, लेकिन मुझे यह बिल्कुल पसंद नहीं है।

किसी अन्य डेवलपर के साथ, किसी अन्य डेवलपर के साथ, कमिटमेंट का पूरा संदेश "स्पेस की जगह", "त्रुटि निर्धारित" या (टीम की संस्कृति पर निर्भर करता है) जैसे वाक्यांशों के लिए कम किया जा सकता है। इसके बजाय, दान ने दूसरों के लिए एक विस्तृत विवरण बनाने के लिए समय लिया। मैं उन कारणों पर ध्यान केन्द्रित करना चाहूंगा जिनकी वजह से मैं इसे वास्तव में एक अच्छा उदाहरण मानता हूं।

परिवर्तनों का कारण बताता है

कमिट्स का सबसे अच्छा वर्णन न केवल इस बारे में बताता है कि क्या बदल गया है, बल्कि यह भी बताएं कि क्यों । हमारे मामले में:

मैंने सुविधा शाखा में `/ etc / nginx / router_routes.conf` की सामग्री से मिलान करने के लिए कई परीक्षण लागू किए हैं। वे अच्छी तरह से काम करते हैं यदि कमांड के साथ चलते हैं 'बंडल एग्जाम्पल रेक स्पेक' या 'बंडल एक्जीक्यूट आरएसपीईसी मॉड्यूल / राउटर / स्पेक'। लेकिन जब `बंडल एग्जाम्पल रेक` चल रहा हो, तो प्रत्येक को ब्लॉक करना चाहिए:

  ArgumentError: invalid byte sequence in US-ASCII 

इस तरह के विस्तार के स्तर के बिना, हम यह मान सकते हैं कि किसी विशेष उपकरण में पार्सिंग त्रुटि को सही किया। प्रतिबद्ध के वर्णन के लिए धन्यवाद, हम जानते हैं कि यह किस प्रकार का उपकरण था।

इस तरह की जानकारी वास्तव में मूल्यवान हो सकती है, और इसे खोना बहुत आसान है, क्योंकि लोग अपने काम की जटिलताओं को भूल जाते हैं, अन्य टीमों में चले जाते हैं और अंततः कंपनी छोड़ देते हैं।

खोज के लिए अच्छा है

इस विवरण के प्रमुख तत्वों में से एक स्वयं त्रुटि है, जिसके साथ आगे की खोज शुरू हुई:

ArgumentError:
US-ASCII में अमान्य बाइट अनुक्रम

जो भी इस त्रुटि का सामना करता है, वह कोड आधार खोज सकता है, या तो git log --grep "invalid byte sequence" , या GitHub खोज का उपयोग करके। वास्तव में, खोज परिणामों को देखते हुए, कई लोग पहले ही ऐसा कर चुके हैं और यह पता लगा चुके हैं कि इस समस्या का सामना कब और किसने किया और इसे आखिर कैसे हल किया गया।

एक संपूर्ण चित्र प्रदान करता है

प्रतिबद्ध संदेश बताता है कि समस्या कैसे दिखती है, इसकी जांच और समाधान कैसे हुआ। उदाहरण के लिए:

अंत में, मैंने पाया कि `.with_content (//)` की अभिव्यक्ति के अपवाद के बाद, सभी त्रुटियां दूर हो जाती हैं। कि विनिर्देश फ़ाइल में कोई अजीब अक्षर नहीं हैं। और यह भी कि इसे उसी दुभाषिया में कठपुतली कहकर खेला जा सकता है।

यह उन क्षेत्रों में से एक है जिसमें कमिट्स पर संदेश वास्तव में खुद को दिखाने में सक्षम होते हैं, क्योंकि वे परिवर्तन का वर्णन करते हैं, और कुछ फ़ाइल, फ़ंक्शन या कोड की रेखा नहीं। यह उन्हें इस तरह की अतिरिक्त कोड बेस एडवेंचर जानकारी स्टोर करने के लिए एक शानदार जगह बनाता है।

सभी को थोड़ा होशियार बनाता है

डैन ने यहां एक काम किया, जिसकी मैं वास्तव में सराहना करता हूं: उन सभी टीमों को लाया जिन्हें मैंने प्रत्येक चरण में प्रदर्शन किया था। यह एक टीम में ज्ञान साझा करने का एक शानदार और सस्ता तरीका है। कमिट के उनके विवरण को पढ़कर, आप यूनिक्स टूल्स के बारे में बहुत कुछ जान सकते हैं:

• आप प्रत्येक फ़ाइल के साथ एक कमांड निष्पादित करने के find -exec तर्क पास कर सकते हैं;
• कमांड के अंत में \+ जोड़ने से कुछ बहुत दिलचस्प हो जाता है ( file कमांड में कई फ़ाइल नाम पास करता है, और प्रत्येक फ़ाइल के लिए एक बार कमांड निष्पादित नहीं करता है);
• file --mime के MIME प्रकार का पता लगाने की अनुमति देता है;
• एक उपयोगिता iconv ।

विवरण देखने वाला व्यक्ति इन सभी चीजों के बारे में जान सकता है। जो भी बाद में इस पर ठोकर खाता है, वह इन चीजों के बारे में भी सीखेगा। यदि आप लंबे समय तक और उनमें से पर्याप्त संख्या के लिए इस दृष्टिकोण को गुणा करते हैं, तो यह टीम के लिए एक शक्तिशाली प्रोत्साहन-सहायक बन सकता है।

सहानुभूति और विश्वास विकसित करता है

अब परीक्षण काम करते हैं! मेरे जीवन का पूरा एक घंटा नहीं लौटाया जा सकता ...

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

अब एक ऐसे ही संदेश की कल्पना करें जो एक अस्थायी हैक या प्रोटोटाइप कोड के टुकड़े से जुड़ा हो जो उत्पादन में मिला और "रूट लिया" (जैसा कि अक्सर ऐसे टुकड़ों के साथ होता है)। प्रतिबद्ध का यह विवरण सभी को याद दिलाता है कि प्रत्येक परिवर्तन के पीछे एक व्यक्ति है जो उस समय उपलब्ध जानकारी को देखते हुए, सबसे अच्छा निर्णय संभव बनाता है।

अच्छी बात है

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

यदि आप कमिट्स के अच्छे विवरणों और कुछ टूल्स के बारे में जानना चाहते हैं, जो एडिट्स को आसान बनाते हैं, तो मैं निम्नलिखित सामग्रियों की सिफारिश कर सकता हूं:

• जोएल चिपिंडले द्वारा " अपने कमिट के माध्यम से कहानियां सुनाना";
• Tekin Süleyman द्वारा " समय में एक शाखा "।

अनुवादक से पी.एस.

हमारे ब्लॉग में भी पढ़ें:

• “ होता है! 6 विशिष्ट जीआईटी त्रुटियां और उन्हें कैसे ठीक करें ";
• "एक ओपन सोर्स प्रोजेक्ट मेंटेनर एक दिन बनाने के लिए एक अद्भुत चाल ";
• “ बड़ी सफल ओपन सोर्स परियोजनाएं क्या आम हैं? "।