उचित कमिट संदेश

Question

के लिए संदेश क्या हैं? मैं हमेशा उनके द्वारा किए गए कार्यों के स्पष्टीकरण के रूप में उन्हें लिख रहा हूं, लेकिन मैंने हाल ही में एक सहयोगी के साथ इस बारे में चर्चा की है जो संदेश लिखता है कि उसने ऐसा क्यों किया। कौन सा सही है, या क्या कोई और जवाब पूरी तरह से है?

नोट: मुझे इस बारे में बिल्कुल कोई जानकारी नहीं है कि इसके लिए "सही" उत्तर है या नहीं। इस प्रकार, मैंने इसे समुदाय विकी लेबल किया है और एक उत्तर स्वीकार नहीं करेगा। उपरोक्त विजेता का निर्णय लेंगे :)

Answer 1

व्यक्तिगत वरीयता के रूप में, मैं बता सकता हूं कि सीधे फ़ाइलों में अंतर देखकर किया गया था। क्यों वह चीज है जो मैं वास्तविक परिवर्तनों को देखने से नहीं जान सकता।

यदि परिवर्तन महत्वपूर्ण या जटिल हैं, तो मैं न केवल क्यों शामिल होगा, बल्कि का एक संक्षिप्त अवलोकन भी।

Answer 2

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

Answer 3

मैं एक executive summaryकी क्या बदल गया था के रूप में प्रतिबद्ध संदेश का उपयोग करें।

कार्यकारी सारांश एक [...] कम है कि को सारांशित दस्तावेज़ है [...] इस तरह से है कि पाठकों को तेजी से यह सब पढ़ने के लिए बिना सामग्री का एक बड़ा शरीर से परिचित हो सकते हैं।

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

Answer 4

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

किसी ऐसे व्यक्ति के रूप में जो दशकों तक फैले बड़े कोड अड्डों पर काम करता है, और एक या दो साल तक चलने वाली छोटी परियोजनाओं के रूप में, मुझे "ओप्स" या "फिक्स्ड बग" जैसे संदेशों की तुलना में प्रतिबद्ध लॉग को जोड़ते समय कुछ और परेशान नहीं होता है। यदि आपने एक बग तय किया है, तो हमें बताएं कि कौन सा (एक बग संख्या, कम से कम)। सड़क के नीचे अपरिहार्य फोरेंसिक के लिए यह सब महत्वपूर्ण है।