Tutorial

[Dev Tip] 5 Tips to write a good Git Commit Message!

By Arnon Puitrakul - 21 September 2015 - 1 min read min(s)

[Dev Tip] 5 Tips to write a good Git Commit Message!

ตอนนี้หลายๆ คนก็ได้ใช้ Git เป็น VCS ในการพัฒนาโปรแกรมแล้ว แรกๆ ผมก็เขียนแบบ งงๆ เหมือนกัน จนตอนหลังมีพี่คนนึงมาสอนว่า Commit Message ที่ดีมันควรจะทำยังไง วันนี้ผมเลยหยิบยกมันมาลองเขียนให้ลองอ่านกัน เพื่อจะเอาไปปรับใช้กับ Project ของตัวเองกันนะครับ

อย่าเขียน Subject ให้ยาวเกินไป

Subject ควรจะเป็นการสรุปสั้นๆ ไม่น่าเกิน 50 ตัวอักษรกำลังดี เขียนให้มันดูเรียบง่าย ได้ใจความสำคัญ และต้องมั่นใจด้วยว่า คนอื่นมาอ่านแล้วรู้เรื่องนะ ไม่งั้นจะเขียนทำไมล่ะเนอะ

พยายามเขียน Subject ให้ได้ข้อมูลมากที่สุด

สืบมาจากข้อที่แล้วเลย Subject ที่ดีของ Git คือ เรียบง่าย กระชับและได้ใจความมากที่สุด ถ้าจริงๆ Subject ของเรามันสามารถสื่อสารได้ครบถ้วนแล้วก็ไม่จำเป็นต้องเขียนส่วนของ body ด้วยก็ได้ เพราะเราได้อธิบายในส่วนของ Subject ไปหมดแล้ว

ตัวอักษรแรกของ Subject ให้ใช้ตัวใหญ่เสมอ

ลองคิดเล่นๆ ถ้าเราเรียก log มันออกมา แล้วเขียนอะไรกันมาก็ไม่รู้ ว่าอันไหนเป็นอันไหนเลย การใช้ตัวแรกของ Subject ให้เป็นตัวใหญ่ก็จะทำให้ คนอ่านสามารถอ่านมันได้ง่ายขึ้นเยอะเลย

ลดตัวอักษรที่ไม่จำเป็น

จากข้อแรก ที่ให้พยายามกำหนดให้มันไม่เกิน 50 ตัวอักษร แต่ถ้าเราเอา 50 ตัวอักษรมานั่งพิมพ์ สิ่งที่ไม่จำเป็นเช่น - หรือ . อะไรแบบนี้ มันทำให้สิ้นเปลืองโควต้า 50 ตัวอักษรของเรา ถ้ามันไม่ทำให้ความหมายของ Message ที่เราต้องการสื่อเปลี่ยนไปก็เอาออกเถอะครับ

ทำให้ Body ของเรามัน Warp ไม่เกิน 70 กว่าตัวอักษร

อันนี้ง่ายมากๆ ลองคิดดูนะครับ ว่าเวลาเราเรียก Log ออกมาเราอยากจะอ่าน Message ที่ยาวออกด้านข้างมากๆ เหรอครับ ถ้าไม่ ก็ให้เรา Warp Message ของเราไปเลย สัก 73 ตัวอักษรก็กำลังดีเลยล่ะ
5 Tips ที่ผมได้เล่าไปน่าจะทำให้ Git ของใครหลายๆ คนน่าอ่านขึ้นเยอะนะครับ Git น่าอ่าน Project ไหลลื่นนะครับ สวัสดีครับ!