- commit message अच्छी तरह लिखना क्यों ज़रूरी है
- एकसमान और स्पष्ट commit message दूसरे developers को आसानी से समझने में मदद करते हैं
- अच्छे commit message इस्तेमाल करने से code की समस्याओं को debug करना आसान होता है
- अच्छी तरह लिखे गए git commit message उसी project पर काम करने वाले दूसरे developers और भविष्य के अपने लिए बदलावों का context पहुंचाते हैं
- अच्छा commit message लिखने का तरीका
- शुरुआत में यह बताने के लिए commit type तय करें कि commit में क्या शामिल है
- दूसरे लोगों का ध्यान रखते हुए commit message विस्तार से लिखें (
commit body का उपयोग करें)
- commit message में आदेशात्मक या अनुरोधात्मक लहजा इस्तेमाल करें
- अनावश्यक punctuation हटाएं
- टीम द्वारा तय की गई 'commit convention' का पालन करें
- Infograb product team की commit convention
- commit के प्रकार के अनुसार emoji जोड़कर उसे एक नज़र में समझने लायक बनाया गया
- component, page और function में फर्क करने के लिए component को uppercase में और बाकी page व function को lowercase में लिखा गया
commit body का उपयोग करके commit में details जोड़ी गईं
- संक्षिप्त commit message के लिए 'function' शब्द को छोटा करके 'फ़ंक्शन' लिखा गया
2 टिप्पणियां
इमोजी readability को बेहतर बनाते हैं — इस बात से सच में सहमत होना मुश्किल है। 3 ही इस्तेमाल करें तो शायद ठीक हो..
यह लेख भी अच्छा है.
https://chris.beams.io/posts/git-commit/
https://item4.github.io/2016-11-01/How-to-Write-a-Git-Commit-Message/