मुझे कभी भी एक रेपो पर एक टीम के साथ काम करने का मौका नहीं मिला है, इसलिए मैं सोच रहा हूं कि आपके परिवर्तनों को दस्तावेज करने का कोई उचित तरीका है या नहीं।रिपोजिटरी कमिट संदेश शिष्टाचार
उदाहरण के लिए, शायद एक टैग जोड़ें जैसे कि: बगफिक्स, अपडेट, कार्यान्वित करें? पेशेवरों ने उनके कामों का वर्णन करने के बारे में सिर्फ उत्सुकता व्यक्त की है।
उम्मीद है कि यह मेरे संगठित परियोजना रखने में सहायता देंगे ...
यह एक स्पष्ट, क्या बदल गया है या कि प्रतिबद्ध में लागू किया गया था के संक्षिप्त विवरण होना चाहिए। यदि आपने किसी समस्या ट्रैकिंग सिस्टम के साथ एकीकृत किया है, तो समस्या संख्या भी उपयोगी है।
नीचे की रेखा है, संदेश को अन्य लोगों को समझना चाहिए, ताकि वे समझ सकें कि कोड को देखे बिना क्या किया गया था, और बी) स्वयं, जब आप एक साल बाद लॉग को देखते हैं तो जहां आपने फूबर के साथ बग तय किया था। एक अच्छा संदेश की
उदाहरण:
Fixed the bug where the program would crash if the number of entries was zero (issue #2857)
एक बुरा संदेश का उदाहरण:
Fixed email bug
इस के लिए बहुत अलग दृष्टिकोण, कुछ लोगों को भी उपयोग नहीं करते संदेशों के लिए प्रतिबद्ध है, लेकिन एक के लिए प्रतिबद्ध हैं बाकी के साथ चेंजलॉग फ़ाइल (हालांकि मैं इसकी अनुशंसा नहीं करता हूं, यह हर समय विलय करने का दर्द है)। मैं माइकल के साथ सभी तरह से सहमत हूं, बस यह इंगित करना चाहता था कि संदेशों को करने के लिए अलग-अलग वातावरण कम या ज्यादा सहायक होते हैं, उदाहरण के लिए गिट में certain preference है जो संदेश दिखना चाहिए।
यदि आप उदाहरण के लिए trac का उपयोग कर रहे हैं, तो यह आपको एक निश्चित वाक्यविन्यास (जैसे # 1234, कम से कम मुझे लगता है) के साथ टिकट संख्या डालने में मदद करेगा, जो इसे दिखाएगा ट्रैक की टाइमलाइन में देखे जाने पर एक हाइपरलिंक।
जितना संभव हो उतना वर्बोज़ हमेशा सबसे अच्छा विचार है।
शाखाओं, टैग और विलय को सही ढंग से टिप्पणी करना सुनिश्चित करें। यह आपको सिरदर्द बचाएगा।
यानी MERGE: [from location] [Start repo #] : [end repo #] - [additional comments]
प्रतिबद्ध टिप्पणियां चाहिए, तुमने किया क्या और क्यों आप यह किया का एक संक्षिप्त विवरण शामिल हैं पर कैसे जानकारी के बिना: अगर किसी को जानकारी के इस तरह की जरूरत है, वह देख सकते हैं डिफ। अनावश्यक कार्यान्वयन विवरण के साथ टिप्पणियां भरें मत।