23Jan, 2024
Language blog :
Thai
Share blog : 
23 January, 2024
Thai

Committing Code

By

2 mins read
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 นั้น ๆ

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

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

  3. 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 :>

 

Written by
Pae Flutter
Pae Flutter

Subscribe to follow product news, latest in technology, solutions, and updates

- More than 120,000 people/day visit to read our blogs

Other articles for you

01
March, 2024
JS class syntax
1 March, 2024
JS class syntax
เชื่อว่าหลายๆคนที่เขียน javascript กันมา คงต้องเคยสงสัยกันบ้าง ว่า class ที่อยู่ใน js เนี่ย มันคืออะไร แล้วมันมีหน้าที่ต่างกับการประกาศ function อย่างไร? เรามารู้จักกับ class ให้มากขึ้นกันดีกว่า class เปรียบเสมือนกับ blueprint หรือแบบพิมพ์เขียว ที่สามารถนำไปสร้างเป็นสิ่งของ( object ) ตาม blueprint หรือแบบพิมพ์เขียว( class ) นั้นๆได้ โดยภายใน class

By

4 mins read
Thai
01
March, 2024
15 สิ่งที่ทุกธุรกิจต้องรู้เกี่ยวกับ 5G
1 March, 2024
15 สิ่งที่ทุกธุรกิจต้องรู้เกี่ยวกับ 5G
ผู้ให้บริการเครือข่ายในสหรัฐฯ ได้เปิดตัว 5G ในหลายรูปแบบ และเช่นเดียวกับผู้ให้บริการเครือข่ายในยุโรปหลายราย แต่… 5G มันคืออะไร และทำไมเราต้องให้ความสนใจ บทความนี้ได้รวบรวม 15 สิ่งที่ทุกธุรกิจต้องรู้เกี่ยวกับ 5G เพราะเราปฏิเสธไม่ได้เลยว่ามันกำลังจะถูกใช้งานอย่างกว้างขวางขึ้น 1. 5G หรือ Fifth-Generation คือยุคใหม่ของเทคโนโลยีเครือข่ายไร้สายที่จะมาแทนที่ระบบ 4G ที่เราใช้อยู่ในปัจจุบัน ซึ่งมันไม่ได้ถูกจำกัดแค่มือถือเท่านั้น แต่รวมถึงอุปกรณ์ทุกชนิดที่เชื่อมต่ออินเตอร์เน็ตได้ 2. 5G คือการพัฒนา 3 ส่วนที่สำคัญที่จะนำมาสู่การเชื่อมต่ออุปกรณ์ไร้สายต่างๆ ขยายช่องสัญญาณขนาดใหญ่ขึ้นเพื่อเพิ่มความเร็วในการเชื่อมต่อ การตอบสนองที่รวดเร็วขึ้นในระยะเวลาที่น้อยลง ความสามารถในการเชื่อมต่ออุปกรณ์มากกว่า 1 ในเวลาเดียวกัน 3. สัญญาณ 5G นั้นแตกต่างจากระบบ

By

4 mins read
Thai
01
March, 2024
จัดการ Array ด้วย Javascript (Clone Deep)
1 March, 2024
จัดการ Array ด้วย Javascript (Clone Deep)
ในปัจจุบันนี้ ปฏิเสธไม่ได้เลยว่าภาษาที่ถูกใช้ในการเขียนเว็บต่าง ๆ นั้น คงหนีไม่พ้นภาษา Javascript ซึ่งเป็นภาษาที่ถูกนำไปพัฒนาเป็น framework หรือ library ต่าง ๆ มากมาย ผู้พัฒนาหลายคนก็มีรูปแบบการเขียนภาษา Javascript ที่แตกต่างกัน เราเลยมีแนวทางการเขียนที่หลากหลาย มาแบ่งปันเพื่อน ๆ เกี่ยวกับการจัดการ Array ด้วยภาษา Javascript กัน เรามาดูตัวอย่างกันเลยดีกว่า โดยปกติแล้วการ copy ค่าจาก value type ธรรมดา สามารถเขียนได้ดังนี้

By

4 mins read
Thai

Let’s build digital products that are
simply awesome !

We will get back to you within 24 hours!Go to contact us
Please tell us your ideas.
- Senna Labsmake it happy
Contact ball
Contact us bg 2
Contact us bg 4
Contact us bg 1
Ball leftBall rightBall leftBall right
Sennalabs gray logo28/11 Soi Ruamrudee, Lumphini, Pathumwan, Bangkok 10330+66 62 389 4599hello@sennalabs.com© 2022 Senna Labs Co., Ltd.All rights reserved.