วิธีเขียนข้อความ Git commit ให้ดี

• เหตุผลที่ควรเขียนข้อความ commit ให้ดี

1. ข้อความ commit ที่สม่ำเสมอและชัดเจนช่วยให้นักพัฒนาคนอื่นเข้าใจได้ง่ายขึ้น
2. การใช้ข้อความ commit ที่ดีช่วยให้ดีบักปัญหาในโค้ดได้ง่ายขึ้น
3. ข้อความ git commit ที่เขียนอย่างดีช่วยส่งต่อบริบทของการเปลี่ยนแปลงให้แก่นักพัฒนาคนอื่นที่ทำงานในโปรเจกต์นั้น และให้ตัวเราในอนาคต

• วิธีเขียนข้อความ commit ที่ดี

1. ระบุประเภทของ commit ไว้ด้านหน้าเพื่อบอกว่าเป็นการเปลี่ยนแปลงเกี่ยวกับอะไร
2. เขียนข้อความ commit ให้ละเอียดเพื่อคำนึงถึงผู้อื่น (commit body การใช้งาน)
3. ใช้น้ำเสียงแบบคำสั่งหรือคำขอในข้อความ commit
4. ตัดเครื่องหมายวรรคตอนที่ไม่จำเป็นออก
5. ปฏิบัติตาม commit convention ที่ทีมกำหนด

• commit convention ของทีมผลิตภัณฑ์ Infograb

1. เพิ่มอีโมจิตามประเภทของ commit เพื่อให้ดูเข้าใจได้ง่ายในทันที
2. เพื่อแยกความต่างระหว่างคอมโพเนนต์ หน้าเพจ และฟังก์ชัน จึงเขียนคอมโพเนนต์ด้วยตัวพิมพ์ใหญ่ และหน้าเพจกับฟังก์ชันอื่น ๆ ด้วยตัวพิมพ์เล็ก
3. ใช้ commit body เพื่อเพิ่มรายละเอียดลงใน commit
4. เพื่อให้ข้อความ commit กระชับ จึงย่อคำว่า function เป็น ‘ฟังก์ชัน’

[roxie]

ผมเห็นด้วยได้ยากมากจริง ๆ กับส่วนที่บอกว่าอีโมจิช่วยเพิ่มความอ่านง่าย ไม่รู้สิ ถ้าใช้แค่ 3 อันก็คงพอว่าไปอย่าง..

[kandk]

บทความนี้ก็ดีเช่นกัน
https://chris.beams.io/posts/git-commit/
https://item4.github.io/2016-11-01/How-to-Write-a-Git-Commit-Message/