छोटी बग फिक्स और छोटी सुविधाओं के लिए कौन बेहतर है - टिकट नंबर द्वारा शाखाओं का नामकरण या फीचर विवरण द्वारा उनका नामकरण?

Question

मैं उचित शाखा के नामकरण के बारे में अपने नेतृत्व के साथ असहमति (सौहार्दपूर्ण, निश्चित रूप से) के बीच में हूं। यह बग-फिक्स और छोटी सुविधा शाखाओं पर लागू होता है, न कि लंबे समय तक चलने वाली सुविधा शाखाओं पर। लंबे समय से चल रही सुविधा शाखाओं के लिए, हम सहमत हैं कि मानव-पठनीय नाम बेहतर हैं। यहाँ दो दृष्टिकोण हैं:

मेरी:

उनकी टीम और टिकट संख्या के अनुसार नामकरण शाखाएं बेहतर हैं। यह हमारे टिकट प्रणाली में उन्हें खोजने के लिए आसान बनाता है, और टाइप करने के लिए कम है। टिकट की ऐतिहासिक जानकारी की तलाश में जीआईटी में प्रासंगिक शाखाओं को देखना भी आसान हो जाता है।

उदाहरण:

team-name/12345
team-name/53719

उसके:

उनकी सुविधा / कार्यक्षमता के अनुसार शाखाओं का नामकरण। यह स्वत: पूर्ण करने के लिए आसान बनाता है, और व्यक्तिगत संख्याओं की तुलना में याद रखना आसान है।

उदाहरण:

team-name/fix-that-sql-bug
team-name/expand-http-parser

एक समझौता जो मैंने पेश किया वह यह है:

team-name/12345-fix-that-sql-bug

लेकिन उसे यह पसंद नहीं है, क्योंकि यह जीआईटी स्वत: पूर्ण के साथ खिलवाड़ करता है।

यदि यह मुख्य रूप से राय-आधारित है, तो कृपया मुझे यह मार्गदर्शन करने के लिए स्वतंत्र महसूस करें कि यह एसओ के लिए एक बेहतर फिट कैसे हो सकता है - लेकिन मुझे लगता है कि मैंने जो कारण बताए हैं, उन्हें एक आनुभविक उत्तर देने के लिए संशोधित / जोड़ा जा सकता है।

Comments

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

— gnat

Answer 1

इस मामले में ऐसा लगता है कि आप दोनों एक नामकरण सम्मेलन पर समझौता कर सकते हैं जिसमें संख्या और विवरण दोनों हैं:

उदाहरण:

टीम के नाम / (12345) -fix-कि-एसक्यूएल-बग

टीम के नाम / (53719) -expand-http-पार्सर

यहां वास्तव में कोई सही उत्तर नहीं है, यह आपके दृष्टिकोण के आधार पर व्यक्तिपरक है।

लेकिन अगर आप दोनों समझौता करते हैं तो आपको दोनों दुनिया में सबसे अच्छा मिलता है। जब मैं अपनी टीम पर इसी तरह की असहमति रखता हूं तो मैं कोशिश करता हूं और इसे ध्यान में रखता हूं।

संपादित करें:

स्वत: पूर्ण होने वाली समस्या से निपटने के लिए, आप क्रमांकित आईडी को कोष्ठक में रख सकते हैं, इस तरह जब आप एक शाखा में टाइप करते हैं तो आप हमेशा टाइप करते हैं (शाखाओं को देखने के लिए। इस सूची से आप क्रमांकित आईडी और विवरण देख पाएंगे। बस एक युगल संख्या, टैब में कुंजी, और यह होगा

Comments

मैं सहमत हूं, और मैंने इसे जोड़ा - मुझे लगता है कि इस समझौते से असहमत होना मूर्खतापूर्ण है।

— कोडमैन

क्या स्वतः पूर्ण केवल शाखा नाम की शुरुआत से काम करता है? क्या आप आईडी को अंत में रख सकते हैं? मैं स्वत: पूर्ण कार्यक्षमता का उपयोग नहीं करता हूं इसलिए मैं इससे अपरिचित हूं।

— dmck

हां, यह शुरू से अंत तक काम करता है - यदि आप प्राप्त करना चाहते हैं तो आपको अनिवार्य रूप से टीएबी team-name/12345-my-ticket-fixटाइप करना होगा team-name/123।

— कोडमैन

@ Pheonixblade9 एक संभावित समाधान के लिए मेरा संपादन देखें, शाखा नाम टाइप करते समय (आईडी से पहले आपको आईडी पता करने से रोकना चाहिए

— dmck

Answer 2

यह वास्तव में तब तक मायने नहीं रखता है जब तक कि एक सुसंगत प्रणाली है जो हर कोई सहमत है और समझता है।

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

team-name/bug-that-has-specific-circumstances-to-occur-and-takes-alot-to-describe

Answer 3

स्वत: पूर्ण का लाभ लेने के लिए कुछ नामकरण करना बेवकूफी है।

मैं मानता हूं कि बग ट्रैकर का एक लिंक महत्वपूर्ण है (एक अच्छे नाम से अधिक महत्वपूर्ण है क्योंकि यह शाखा द्वारा हल की जा रही समस्या को परिभाषित करता है जो कुछ शब्द नहीं करता है) लेकिन एक ही समय में, लोगों से अपेक्षा करने में इसकी प्रयोज्य विफलता बग # 7312 और # 7213 के बीच अंतर जानने के लिए। इसके अलावा लोगों को यह उम्मीद करना एक विफलता है कि हर बार नंबर पूरी तरह से सही मिलेंगे - एक दिन कोई गलत शाखा के लिए प्रतिबद्ध होगा क्योंकि उन्होंने 7213 के लिए 7312 गलत / गलत लिखा था। (मेरी टीम में किसी ने आज ऐसा किया!)

इसलिए दोनों को करें - शाखा को नंबर दें और एक चेक के रूप में कार्य करने के लिए बहुत छोटा पाठ विवरण जोड़ें। मैं पहले नंबर डालूंगा - स्वतः पूर्ण हो जाना - जैसा कि आपको अभी भी शाखा का पाठ जानना है (जैसे "बग-फिक्स-फॉर-सर्वर" या "फिक्स-बग-फॉर-सर्वर" - आपको अभी भी जानना होगा अगर यह f या b से शुरू होता है!