शुरू करना

हमारे कमिट कन्वेंशन के बारे में जानें

2 min read
302 words

हम एक साफ प्रोजेक्ट इतिहास रखना चाहते हैं। हमारे कमिट्स की परंपरा Conventional Commits से प्रेरित है लेकिन इसे gitmoji के साथ कस्टमाइज किया गया है ताकि इसे और विजुअल और मजेदार बनाया जा सके।

संरचना

कमिट संदेश को इस तरह संरचना की जानी चाहिए और निचले अक्षरों में:

<gitmoji> <type> <description> [(#<issue number>)]

[वैकल्पिक संपूर्णक]

[वैकल्पिक फूटर(स)]

उदाहरण

📝 update documentation contributors

- Add @jerembdn as a contributor
- Add @younesbessa as a contributor

Co-authored-by: Younes Bessa <[email protected]>

अधिकतर एक साधारण एक-लाइनर पर्याप्त होता है:

📝 update documentation contributors

प्रकार

हम निम्नलिखित कमिट प्रकारों का उपयोग करते हैं:

TypeDescription
addएक नई विशेषता जोड़ें
fixएक बग ठीक करें
improveकुछ सुधारें
updateकुछ अपडेट करें
removeकुछ हटाएँ
refactorकुछ को फिर से रूप दें
renameकुछ का नाम बदलें
moveएक फाइल या फ़ोल्डर स्थानांतरित करें
upgradeनिर्भरताएँ अपडेट करें
downgradeनिर्भरताएँ डाउनग्रेड करें

विवरण

विवरण आज्ञाकारी रूप और निचले अक्षरों में लिखें:

# अच्छा
📝 update documentation contributors

# बुरा
📝 updated documentation contributors

# बुरा
📝 Update documentation contributors

मुद्दा संख्या

कमिट्स को मुद्दों से लिंक करने के लिए मुद्दा संख्या जोड़ें:

📝 update documentation contributors (#123)

संपूर्णक

संदर्भ और प्रेरणा के लिए संपूर्णक का उपयोग करें:

📝 update documentation contributors

- Add @jerembdn as a contributor
- Add @younesbessa as a contributor

Co-authored-by: Younes Bessa <[email protected]>

एक कमिट, एक उद्देश्य

प्रत्येक कमिट को एकल तार्किक परिवर्तन का प्रतिनिधित्व करना चाहिए। अव्यवस्थित परिवर्तनों को मिलाएं नहीं।