शुरुआत करना
हमारा कमिट सम्मेलन सीखें
हम एक साफ-सुथरी प्रोजेक्ट इतिहास पसंद करते हैं। हमारे कमिट की परंपरा Conventional Commits से प्रेरित है लेकिन इसे gitmoji के साथ कस्टमाइज किया गया है ताकि इसे और ज्यादा विजुअल और मजेदार बनाया जा सके।
संरचना
कमिट संदेश को इस तरह से संरचित किया जाना चाहिए और निम्नलिखित छोटे अक्षरों में:
<gitmoji> <type> <description> [(#<issue number>)]
[optional body]
[optional footer(s)]
उदाहरण
📝 अपडेट डोक्यूमेंटेशन योगदानकर्ता
- @jerembdn को एक योगदानकर्ता के रूप में जोड़ें
- @younesbessa को एक योगदानकर्ता के रूप में जोड़ें
Co-authored-by: Younes Bessa <[email protected]>
अधिकतर समय, एक साधारण एक-लाइनर काफी है:
📝 अपडेट डोक्यूमेंटेशन योगदानकर्ता
प्रकार
हम निम्नलिखित कमिट प्रकारों का उपयोग करते हैं:
| प्रकार | विवरण |
|---|---|
add | एक नई सुविधा जोड़ें |
fix | एक बग ठीक करें |
improve | कुछ सुधारें |
update | कुछ अपडेट करें |
remove | कुछ हटाएँ |
refactor | कुछ को फिर से तैयार करें |
rename | कुछ का नाम बदलें |
move | एक फाइल या फ़ोल्डर को स्थानांतरित करें |
upgrade | निर्भरताओं को अपडेट करें |
downgrade | निर्भरताओं को डाउनग्रेड करें |
initial | एक भंडारण का प्रारंभिक कमिट |
release | रिलीज / संस्करण टैग |
एक भंडारण का पहला कमिट initial का उपयोग करता है, और एक संस्करण टैग का उपयोग
release:
🎉 प्रारंभिक कमिट
🔖 रिलीज @onruntime/translations v0.3.0
विवरण
<type> विषय का क्रिया है, और विवरण इसे पूरा करता है। साथ में पढ़ने पर, वे एक वाक्य बनाते हैं:
# अच्छा
📝 अपडेट डोक्यूमेंटेशन योगदानकर्ता
तो विवरण को एक दूसरे क्रिया से न खोलें। प्रकार पहले से ही एक है, और
विषय अंत में दो वाक्य जोड़ देता है, जो एक fix: उपसर्ग की ओर ले जाता है। क्रिया को छोड़ दें और उस पर ध्यान दें जिस पर यह कार्रवाई करता है:
# बुरा
💄 आकार कार्ड पर जेम को सुधारें
🐛 ठीक करें फुटर को लपेटने से रोकें
# अच्छा
💄 कार्ड पर जेम का आकार सुधारें
🐛 फुटर लपेटने को ठीक करें
इसे आज्ञात्मक स्वर और निम्नलिखित छोटे अक्षरों में लिखें:
# बुरा
📝 अपडेटेड डोक्यूमेंटेशन योगदानकर्ता
# बुरा
📝 अपडेट डोक्यूमेंटेशन योगदानकर्ता
एक क्रिया जो एक संज्ञा है
कुछ शब्द दोनों हैं, और जिस शब्द का आप मतलब रखते हैं वह संज्ञा है: ✨ ओपन ग्राफ इमेज जोड़ें
ठीक है। जब यह एक क्रिया के रूप में पढ़ता है, तो एक अनिश्चित लेख इसे फिर से संज्ञा वाक्यांश बना देता है:
✨ एक और दिखाएँ बटन जोड़ें।
मुद्दा संख्या
कमिट को मुद्दों से लिंक करने के लिए मुद्दा संख्या जोड़ें:
📝 अपडेट डोक्यूमेंटेशन योगदानकर्ता (#123)
शरीर
संदर्भ और प्रेरणा के लिए शरीर का उपयोग करें:
📝 अपडेट डोक्यूमेंटेशन योगदानकर्ता
- @jerembdn को एक योगदानकर्ता के रूप में जोड़ें
- @younesbessa को एक योगदानकर्ता के रूप में जोड़ें
Co-authored-by: Younes Bessa <[email protected]>
एक कमिट, एक उद्देश्य
प्रत्येक कमिट को एक एकल तार्किक परिवर्तन का प्रतिनिधित्व करना चाहिए। असंबंधित परिवर्तनों को न मिलाएँ।