फोटो द्वारा Yancy मिन पर Unsplash

Kubernetes एक बड़ी परियोजना है। न केवल इसलिए कि यह बहुत मांग में है , बल्कि स्रोत कोड के दृष्टिकोण से भी है। इस लेखन के समय, 86,000 से अधिक कमिट, 2,000 से अधिक प्रतिभागियों, 2,000 से अधिक खुले टिकट, 1,000 से अधिक खुले पूल अनुरोध और गीथहब पर रिपॉजिटरी में 62,800 सितारे थे। Scc की

उपयोगितागो कोड की 4.3 मिलियन से अधिक लाइनें (5.2 मिलियन से अधिक लाइनें) हैं, जिनमें से 3 मिलियन से अधिक वास्तविक कोड और टिप्पणियों के साथ 700 हजार से अधिक लाइनें हैं, एक निर्देशिका सहित 16,000 से अधिक फाइलें।vendor/

हमने हाल ही में एक उपकरण विकसित किया है जो ऐसी बड़ी परियोजनाओं के समर्थन में मदद करने के लिए एक कोडबेस में TODO टिप्पणियों को संसाधित करता है ।

हमने कुबेरनेट्स स्रोतों पर अपने छोटे पार्सर को निर्धारित करने का फैसला किया - और देखें कि क्या होता है। यहाँ कुछ परिणाम हैं। 9bf52c2 कमिट

tickgit से सोर्स कोड संसाधित किया । CSV प्रारूप में आउटपुट तब क्वेरी प्रसंस्करण के लिए SQLite में आयात किया गया था। ध्यान दें कि उपकरण केवल निकाले गए पेड़ में TODO को पाता है। यह उन टिप्पणियों को ध्यान में नहीं रखता है जिन्हें जोड़ा गया है और बाद में हटा दिया गया है। इस प्रकार, संख्या केवल TODOs को दर्शाती है जो अभी भी इस प्रतिबद्ध के समय कोड में "जीवित" हैं।

कुल ( 9bf52c2 के लिए )

363 लेखकों से 1230 फाइलों में 2380 TODO
460 TODO , , // TODO (patrickdevivo) Fix the ...
489 TODO 2019
TODO — 860 ( 2,3 )
TODO — 6 2014 ( « »)
TODO 9 2019 ( )
TODO: 33
deads2k TODO (git blame): 147
TODO, : 64

TODO

33	cluster/gce/util.sh
25	pkg/apis/core/types.go
23	staging/src/k8s.io/api/core/v1/types.go
21	staging/src/k8s.io/legacy-cloud-providers/aws/aws.go
20	staging/src/k8s.io/code-generator/cmd/conversion-gen/generators/conversion.go
20	pkg/apis/core/validation/validation.go
16	test/e2e/network/service.go
16	pkg/kubelet/kubelet.go
14	test/e2e/framework/util.go
14	pkg/kubelet/kubelet_pods.go

TODO

deads2k				147
Clayton Coleman			105
Chao Xu				99
Dr. Stefan Schimanski		93
Jordan Liggitt			81
David Eads			60
Random-Liu			54
Wojciech Tyczynski		50
Yu-Ju Hong			43
Prashanth Balasubramanian	38

, TODO ( TODO )

64	6a4d5cd7cc58e28c20ca133dab7b0e9e56192fe3
19	e01ff1641c7321ac81fe5775f6ccb21aa6775c04
19	4fb28dafad121e163fa86dc90067ce3d14415811
18	adb75e1fd17b11e6a0256a4984ef9b18957d94ce
14	963c85e1c807efcdbb82dd44439dc3c55f6a0bfd
14	8b17db7e0c4431cd5fd9a5d9a3ab11b04e2f0a7e
13	f0f78299348afcf770d4e8d89dcea82f80811b28
11	d0b94538b9744d0c06df6ddec2604be168568f9d
10	f1248b9c829e225138ab6d6234221c63092f7592
10	cd663d7ad00937cffa8a09e4761acb95d34c89a3

TODO

, TODO : tickgit todos --csv-output. SQLite.

यह कुबेरनेट्स स्रोत कोड में TODO टिप्पणियों पर एक सुंदर सरसरी नज़र है। हम सबसे सक्रिय "कार्य निर्देशकों" को देखते हैं, जो कम या ज्यादा परियोजना के प्रमुख योगदानकर्ताओं के साथ मेल खाते हैं ।

हम यह भी देखते हैं कि TODO टिप्पणियों का रवैया आदर्श से अलग नहीं है, सिर्फ कोड आधार के बड़े आकार के कारण उनमें से कई भी हैं।

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

संभवतः, मुख्य योगदानकर्ता कोड आधार के अपने क्षेत्रों में अच्छी तरह से वाकिफ हैं और स्पष्ट रूप से अपने स्वयं के TODO और "छिपे हुए" की संख्या का प्रतिनिधित्व करते हैं। लेकिन बाहरी पर्यवेक्षकों के लिए यह हमेशा ध्यान देने योग्य नहीं है। गीथहब (या अन्य सार्वजनिक ट्रैकर्स) पर टिकट देखने के लिए वे अधिक परिचित और समझने योग्य हैं।

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

एक गहन विश्लेषण में इतिहास के सभी TODO शामिल होंगे , न कि केवल वे जो वर्तमान में बने हुए हैं। आप निम्नलिखित मुद्दों पर विचार कर सकते हैं:

TODOs कितनी तेजी से बंद होते हैं?
TODO टिप्पणी का औसत जीवनकाल क्या है?
तुलना में लोकप्रिय कोडबेस क्या दिखते हैं?

यह कितना महत्वपूर्ण है?

TODO टिप्पणियां आमतौर पर एक प्रकार का काम कवर करती हैं जो एक टिकट के लिए बहुत छोटा है, लेकिन एक टिप्पणी में उल्लेखनीय और वर्णित है (हालांकि कई टिकट / मुद्दे का उल्लेख करते हैं)। क्योंकि टिप्पणियाँ कोड का हिस्सा हैं, वे अक्सर उस काम के लिए "करीब" होते हैं जिसे करने की आवश्यकता होती है। उन्हें जोड़ना आसान है, लेकिन ऐसा लगता है कि भूलना आसान है (कुबेरनेट्स स्रोतों में अभी भी 1800 से अधिक TODOs हैं जो 2019 से पहले जोड़े गए थे)।

हमें उम्मीद है कि कोड में मेटाडेटा का विश्लेषण करने के लिए हमारा उपकरण डेवलपर्स को किसी भी आकार की परियोजनाओं की सेवा करने में मदद करेगा। TODO टिप्पणियों को धरातल पर उतारा जाना केवल इस बात का हिस्सा है कि क्या किया जाना चाहिए।

कुबेरनेट्स कोड में हजारों भूल गए TODOs

कुल ( 9bf52c2 के लिए )

TODO

TODO

, TODO ( TODO )

TODO

यह कितना महत्वपूर्ण है?

More articles: