कमिट मैसेज से जुड़ी गाइड

कमिट मैसेज

कमिट मैसेज से पुल अनुरोधों की समीक्षा करना और रिलीज़ नोट जनरेट करना आसान हो जाता है. Blockly प्रोजेक्ट, इसके लिए कन्वेंशनल कमिट का इस्तेमाल करता है.

हर कमिट का फ़ॉर्मैट ऐसा होना चाहिए:

<type>: <description>

[optional body]

[optional footer(s)]

ध्यान दें कि Blockly के मुख्य रिपॉज़िटरी में, कमिट लिंटर होता है. इससे इस नियम को लागू करने में मदद मिलती है. अगर आपके पुल अनुरोध में कई कमिट हैं, तो लिंटर टाइटल की जांच करेगा. अगर इसमें सिर्फ़ एक कमिट है, तो यह उस कमिट की जांच करेगा. यह सबसे अच्छा होगा कि आपके व्यक्तिगत कमिट और पुल अनुरोध का टाइटल, दोनों इन दिशा-निर्देशों का पालन करें.

टाइप

टाइप खाली नहीं होना चाहिए और सभी अक्षर छोटे होने चाहिए. यहां स्वीकार किए जाने वाले टाइप की सूची दी गई है.

• chore: उन कमिट के लिए जो रूटीन/ऑटोमेटेड टास्क पूरे करती हैं. जैसे, डिपेंडेंसी अपग्रेड करना.

• deprecate: उन कमिट के लिए जिनमें किसी सुविधा को बंद किया गया हो.

• feat: उन कमिट के लिए जो Blockly में नई सुविधाएं जोड़ते हैं.

• fix: Blockly में गड़बड़ियां/त्रुटियां ठीक करने वाले कमिट के लिए.

• release: नए वर्शन की रिलीज़ से जुड़े कमिट के लिए.

नुकसान पहुंचा सकने वाले बदलाव

ऐसे कमिट जिनमें बड़े बदलाव किए गए हैं उनके टाइप के बाद ! जोड़ना चाहिए. ब्रेकिंग बदलाव ऐसे बदलाव होते हैं जिनसे, अपने ऐप्लिकेशन में Blockly का इस्तेमाल करने वाले डेवलपर को परेशानी हो सकती है. इससे उन्हें ज़्यादा काम करना पड़ सकता है.

उदाहरण के लिए: none fix!: return type of workspace.paste

ब्रेकिंग चेंज, ऊपर दिए गए किसी भी मान्य टाइप का हो सकता है.

ब्यौरा

ब्यौरा खाली नहीं होना चाहिए. साथ ही, इसमें 256 से ज़्यादा वर्ण नहीं होने चाहिए.

मुख्य भाग

मुख्य हिस्सा ज़रूरी नहीं है. अगर यह जानकारी दी गई है, तो इसके और ब्यौरे के बीच एक खाली लाइन होनी चाहिए. इसे 256 वर्णों से ज़्यादा की लाइनों में नहीं तोड़ा जाना चाहिए.

ध्यान दें कि आम तौर पर, इस तरह की जानकारी को सीधे तौर पर कमिट में डालने के बजाय, पुल अनुरोध के ब्यौरे में डालना बेहतर होता है.

Footer

फ़ुटर जोड़ना ज़रूरी नहीं है. अगर इसे दिया जाता है, तो इसके और मुख्य हिस्से के बीच एक खाली लाइन होनी चाहिए. इसे 256 वर्णों से ज़्यादा की लाइनों में नहीं तोड़ा जाना चाहिए.

गैर-पारंपरिक कमिट ठीक करना

अगर आपने बदलाव करते समय, कन्वेंशनल कमिट का इस्तेमाल नहीं किया है, तो आपके पास मैसेज ठीक करने के दो विकल्प हैं. ये विकल्प, आपके कमिट की संख्या पर निर्भर करते हैं:

1. अगर आपके पुल अनुरोध में कई कमिट हैं, तो पुल अनुरोध के टाइटल में बदलाव करके, ज़रूरी शर्तों के मुताबिक बनाएं. पुल अनुरोध मर्ज होने पर, आपकी अन्य कमिट स्क्वैश हो जाएंगी, ताकि टाइटल कमिट मैसेज बन जाए.

2. अगर आपके पुल के अनुरोध में एक ही कमिट है, तो git commit --amend का इस्तेमाल करके अपने कमिट मैसेज में बदलाव करें. इसके बाद, Blockly के अपने फ़ोर्क में बदलावों को फ़ोर्स पुश करें. इससे इस ब्रांच से जुड़े सभी खुले पुल अनुरोध अपने-आप अपडेट हो जाएंगे. git push --force origin my-branch.