Git विविध, वितरित टीमों को एकीकृत कोडबेस पर काम करने में मदद करता है। इस शक्ति के साथ एक जिम्मेदारी भी आती है: अपने परिवर्तनों का अच्छा विवरण छोड़ना।

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

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

एक अच्छे प्रतिबद्ध संदेश की संरचना

प्रतिबद्ध संदेश के एक अच्छे उदाहरण में चार खंड शामिल हैं: प्रकार, विवरण, मुख्य भाग और पादलेख।

जैसे इतना:

: 
[वैकल्पिक निकाय]
[वैकल्पिक पादलेख]

प्रकार

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

instagram viewer

  • करतब: आपके परिवर्तन एक नई सुविधा का परिचय देते हैं।
  • हल करना: आप एक बग ठीक कर दें.
  • रिफैक्टर: बग को ठीक किए बिना या कोई नई सुविधा जोड़े बिना आपका रिफैक्टर कोड बदलें।
  • परीक्षा: आप परीक्षण-संबंधी कोई भी परिवर्तन करते हैं। उदाहरण के लिए, जब आप जेस्ट के साथ परीक्षण लिखें या कोई भी अन्य परीक्षण ढाँचा आप चुनते हैं।
  • घर का काम: किसी सुधार, सुविधा या परीक्षण से असंबंधित परिवर्तन। उदाहरण के लिए, निर्भरताएँ अद्यतन करना।
  • डॉक्स: जब आप दस्तावेज़ अद्यतन करते हैं।
  • शैली: परिवर्तन जो कोड के अर्थ को प्रभावित नहीं करते हैं, जैसे सफेद स्थान जोड़ना, अर्ध-कॉलन गायब करना, आदि।
  • पर्फ़: प्रदर्शन सुधार से संबंधित परिवर्तन.
  • निर्माण: जब आप ऐसे परिवर्तन करते हैं जो बिल्ड फ़ाइलों को प्रभावित करते हैं।
  • सीआई: सतत एकीकरण से संबंधित परिवर्तन.
  • फिर लौट आना: पिछली प्रतिबद्धता पर वापस लौटते समय।

विवरण

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

विवरण लिखते समय निम्नलिखित बातों का ध्यान रखें:

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

उदाहरण के लिए:

करतब: होम पेज के लिए डार्क मोड टॉगल लागू करें

यह उदाहरण दिखाता है कि आप किसी कमिट के लिए विवरण कैसे लिख सकते हैं डार्क मोड लागू करता है. इसका उपयोग करता है करतब टाइप करें क्योंकि यह एक नई सुविधा प्रस्तुत करता है।

बॉडी (वैकल्पिक)

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

प्रतिबद्ध संदेश का मुख्य भाग लिखते समय ध्यान देने योग्य कुछ बातें यहां दी गई हैं:

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

उदाहरण के लिए:

उपलब्धि: GitHub को OAuth प्रदाता के रूप में जोड़ें
निर्बाध रूप से सक्षम करने के लिए GitHub को OAuth प्रदाता के रूप में एकीकृत करें 
GitHub खातों के साथ प्रमाणीकरण।


- GitHub API के साथ OAuth प्रमाणीकरण प्रवाह लागू करें
- GitHub प्रमाणीकरण के लिए आवश्यक समापन बिंदु और सेटिंग्स कॉन्फ़िगर करें
- GitHub लॉगिन विकल्प को शामिल करने के लिए यूजर इंटरफेस को अपडेट करें

उपरोक्त उदाहरण एक सुविधा के लिए एक अच्छा Git प्रतिबद्ध संदेश दिखाता है जो जोड़ता है GitHub एक OAuth प्रदाता के रूप में आपके आवेदन के लिए. इस प्रतिबद्ध संदेश में एक संक्षिप्त सारांश पंक्ति (50 वर्ण या उससे कम), एक अधिक विस्तृत व्याख्यात्मक पाठ (लगभग 72 वर्णों में लपेटा हुआ), और अतिरिक्त जानकारी के लिए बुलेट बिंदु हैं।

कमिट संदेश में पाद लेख अनुभाग एक वैकल्पिक भाग है जो कमिट से संबंधित अतिरिक्त जानकारी या मेटाडेटा प्रदान करता है। इसे आमतौर पर बॉडी सेक्शन के बाद एक रिक्त रेखा से अलग करके रखा जाता है। पाद लेख में विभिन्न प्रकार की जानकारी शामिल हो सकती है, जैसे संबंधित मुद्दों के संदर्भ, टैग या विशेष नोट्स।

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

उदाहरण के लिए:

करतब: GitHub को OAuth प्रदाता के रूप में जोड़ें
निर्बाध रूप से सक्षम करने के लिए GitHub को OAuth प्रदाता के रूप में एकीकृत करें 
GitHub खातों के साथ प्रमाणीकरण।


- GitHub API के साथ OAuth प्रमाणीकरण प्रवाह लागू करें
- GitHub प्रमाणीकरण के लिए आवश्यक समापन बिंदु और सेटिंग्स कॉन्फ़िगर करें
- GitHub लॉगिन विकल्प को शामिल करने के लिए यूजर इंटरफेस को अपडेट करें
समाधान: #123
यह भी देखें: #456, #789

पाद लेख संबंधित मुद्दे #123 का संदर्भ देता है और अतिरिक्त संदर्भ के लिए अन्य संबंधित मुद्दों #456 और #789 का उल्लेख करता है।

प्रतिबद्ध संदेश जोड़ना

आप इसका उपयोग करके प्रतिबद्ध संदेश लिख सकते हैं -एम ध्वज के बाद उद्धरण चिह्नों में संलग्न प्रतिबद्ध संदेश (वैकल्पिक लेकिन अनुशंसित)।

-एम फ़्लैग लघु प्रतिबद्ध संदेशों के लिए आदर्श है, जिसमें आमतौर पर प्रकार और विवरण शामिल होते हैं।

उदाहरण के लिए:

git कमिट -m "कोर: लिंटर को ESlint में बदलें"

हालाँकि, जब आपके प्रतिबद्ध संदेश को अधिक विवरण की आवश्यकता होती है, जैसे कि मुख्य भाग और पादलेख, तो बेहतर होगा कि आप पाठ संपादक या आईडीई में प्रतिबद्धता लिखें।

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

उदाहरण के लिए:

गिट कमिट--फाइल कमिट_मैसेज.txt

जब आप उपरोक्त कमांड चलाएंगे, तो git फ़ाइल की सामग्री को कमिट संदेश के रूप में उपयोग करेगा।

आप लंबा संदेश लिखने के लिए git को अपना डिफ़ॉल्ट संपादक खोलने के लिए भी कह सकते हैं। यदि आपके पास GIT_EDITOR या EDITOR पर्यावरण चर सेट है, तो जब आप बेयर चलाएंगे तो git उस प्रोग्राम को खोल देगा गिट प्रतिबद्ध आज्ञा।

आपको अच्छे प्रतिबद्ध संदेश क्यों लिखने चाहिए?

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

वे ज्ञान साझा करने, सुचारू ऑनबोर्डिंग और संस्करण नियंत्रण का समर्थन करने में सक्षम हैं। गुणवत्तापूर्ण प्रतिबद्ध संदेशों को प्राथमिकता देने से विकास प्रक्रियाएँ बढ़ती हैं और कोडबेस रखरखाव सुनिश्चित होता है।