Committing Code

ในปัจจุบันสำหรับชาว Dev นั้น Version Control ได้เข้ามามีบทบาทอย่างมากในการ Manage Source Code ของเรา และในแต่ละวันเราคงใช้ Git กันเป็นประจำอยู่แล้วในการเก็บ Source Code ของเรา แต่เพื่อน ๆ ชาว Dev ทราบกันหรือเปล่าว่าการ Commit Message สามารถทำให้ทีมเราหรือเราเองสามารถที่จะ Review Code ได้ง่ายขึ้น และในการเก็บ Commit เป็นระเบียบมากขึ้น ในบทความนี้เราจะมาเจาะลึกเกี่ยวกับการเขียน Commit Message กัน

ทำไม Commit Message ของ Git ถึงสำคัญ ?

1. Documentation
   Commit Message จะถูกเก็บเป็นประวัติไว้ใน Version Control การที่เราทำให้ Commit Message เข้าใจง่ายและอ่านง่าย เราก็จะสามารถที่จะหาสิ่งที่เราต้องการหาได้ง่ายขึ่้น

2. Collaboration
   ในการทำงานเป็นทีม Commit Message ที่ดีจะช่วยทำให้ทีมมีการสื่อสารที่มีประสิทธิภาพมากขึ้น การที่ Commit Message ชัดเจนเข้าใจง่าย จะช่วยให้เพื่อนร่วมทีมเข้าใจว่ามีอะไรเปลี่ยนแปลงมาบ้างโดยที่ไม่ต้องใช้เวลาทำความเข้าใจเยอะ และยังช่วยเรื่องของการ Review Code ได้อีกด้วย

3. Troubleshooting
   Commit Message ที่ดีนั้นจะทำให้หา Bug หรือ Defect ต่าง ๆ ได้ง่ายขึ้น

Best Practice for Writing Git Commit Message

1. Be clear and concise

ควรใช้ข้อความที่สั้นกระชับและเข้าใจง่าย เน้นสรุปด้วยประโยคเดียวที่บอกว่าอะไรมีการเปลี่ยนแปลงใน Commit นั้น ๆ

2. Use the imperative mood
   ควรใช้คำขึ้นต้น Commit ด้วยคำกริยา เช่น Add, Fix, Update และ Refactor เพื่อเป็นความหมายหลักในการบอกว่า Commit นั้น ๆ เราทำอะไรเป็นหลัก

3. Include the “Why”
   บอกว่าอะไร ทำไม ถึงเปลี่ยนแปลง เพื่อให้ง่ายต่อการทำความเข้าใจ

4. Follow the team
   ทำตามรูปแบบที่กำหนดของทีมเพื่อให้ Commit Message ไปในทางเดียวกัน

Subject Line Standard Terminology from Git

ตัวอย่าง

Good Commit Message

• Fix authentication bug for user login

• Fix the issue with user authentication

• Add login button to login page

• Update the dependency version to address security vulnerabilities

• Refactor database schema to improve performance

• Release version 1.0.0

• Remove deprecated methods

• Update getting started documentation

นี่คือตัวอย่างของ Commit Message ที่ดี ต่อมาเราไปดู Commit Message ที่ไม่ควรใช้กันบ้าง

Bad Commit Message 

• Fixed bug with Y

• Changing behavior of X

• Add C

สรุป

ในโลกของการพัฒนาซอฟต์แวร์ การที่ทำให้การทำงานร่วมกันและการสื่อสารที่ชัดเจนเป็นสิ่งสำคัญ การเรียนรู้การเขียน Commit Message ของ Git เป็นทักษะที่ชาว Dev อย่างเรา ๆ ควรฝึกฝนและหัดเขียนให้เป็นนิสัย เพราะในการทำงานเป็นทีมหรือทำงานจริง ๆ แล้ว อะไรที่ทำให้เข้าใจง่ายจะทำให้การสื่อสารในทีมดีขึ้น และจะช่วยเพิ่มประสิทธิภาพการทำงานเป็นทีมได้ดีขึ้น สำหรับมือใหม่แล้วในตอนนี้เราอาจจะไม่ค่อยเห็นภาพมาก แต่ถ้าวันนึงเรามีโอกาสได้ไปทำงานร่วมกับทีมที่ทำ Project เยอะ ๆ Commit เราอาจจะเห็นภาพมากขึ้นก็ได้นะ Enjoy coding :>