How to Edit Commit Messages with Git Amend

01-Sep-23

คัมภีร์เทพ IT

See the original english version Click here!

 

Commit Messages บทบาทสำคัญใน Git Version Control โดย Commit Messages ที่ดีควรมีการสื่อความหมายที่ชัดเจน แต่อาจมีบางครั้งที่คุณต้องแก้ไข Commit Message เพราะเขียนผิด หรือข้อมูลยังไม่ชัดเจน เป็นต้น ดังนั้นบทความนี้จะมาแนะนำ วิธีแก้ไข Commit Messages ด้วย Git Amend สำหรับมือใหม่

Git Amend คืออะไร

Git Amend คือคำสั่งของ Git ที่ช่วยให้คุณสามารถแก้ไข Commit อันล่าสุดใน Repository ของคุณโดยไม่ต้องสร้าง Commits อื่นเพิ่มเติม มันมีประโยชน์อย่างยิ่งสำหรับการแก้ไข Commit Messages แม้ว่าคุณจะสามารถใช้มันเพื่อเพิ่มหรือลบ Files จาก Commit ก่อนหน้าได้

เมื่อคุณใช้ Git Amend มันจะแก้ไข Commit อันล่าสุด และแทนที่ด้วย Commit อันใหม่ ที่รวมถึง Changes ต่าง ๆ ที่คุณได้ทำไว้ด้วย สิ่งนี้จะทำให้คุณสามารถแก้ไขหรือปรับปรุง Commit Message หรือ Content ของ Commit ได้

Git Amend เป็นวิธีที่สะดวกในการแก้ไขข้อผิดพลาดเล็ก ๆ น้อย ๆ หรือการละเว้นการ Commit ของคุณ โดยที่ไม่ต้องสร้าง Commit อันใหม่ขึ้นมา มันจะช่วย Maintain Commit History ที่ดูเข้าใจง่าย โดยอนุญาตให้คุณทำการปรับเปลี่ยนโดยที่ไม่ทำให้ Repository เต็มไปด้วย Commits ที่ไม่จำเป็น

วิธีแก้ไข Git Commit Messages

  • ขั้นตอนที่ 1: ระบุ Commit ที่จะแก้ไข

ใช้คำสั่งต่อไปนี้เพื่อดู Commit History และระบุ Commit Message ที่คุณต้องการจะแก้ไข:

มองหา Commit Hash หรือ Commit Message ที่คุณต้องการจะแก้ไข

  • ขั้นตอนที่ 2: ทำการแก้ไข Commit Message

เมื่อคุณระบุ Commit แล้ว ให้ใช้คำสั่งต่อไปนี้ เพื่อแก้ไข Commit Message โดยที่ไม่เปลี่ยนแปลงรายละเอียดอื่น ๆ:

คำสั่งนี้ จะเปิด Default Text Editor (อาจจะเป็น Vim หรือ Nano) พร้อมกับ Commit Message ที่มีอยู่ จากนั้นให้ทำการเปลี่ยนแปลงแก้ไข Message ที่ต้องการ

จากนั้น ทำการ Save และ Exit ออกจาก Text Editor

  • ขั้นตอนที่ 3: ทำการ Save Changes

หลังจากแก้ไข Commit Message แล้ว Git ก็จะ Update Commit ด้วย Message ที่ถูกแก้ไข แต่สิ่งสำคัญก็คือ คุณควรตรวจสอบ Changes ทั้งหมด ก่อนที่จะทำการ Save 

คุณสามารถใช้คำสั่งต่อไปนี้ เพื่อตรวจสอบ Changes ที่ทำกับ Commit Message:

สิ่งนี้จะแสดง Changes ที่คุณทำกับ Commit Message และอย่าลืมตรวจสอบให้แน่ใจว่า Changes เหล่านั้นมีความถูกต้องและเป็น Message ที่คุณต้องการจะแก้ไขแล้ว

  • ขั้นตอนที่ 4: ทำการ Push Commit ที่ถูกแก้ไขแล้ว

แต่การ Push Commit ที่ถูกแก้ไขแล้ว ก็อาจเกิดปัญหาขึ้นได้เช่นกันหากคุณทำการ Push Commit อันเดิมไปยัง Repository ที่มีการใช้งานร่วมกัน ซึ่งโดยทั่วไป จะไม่แนะนำให้ทำการแก้ไข Commits ที่ถูก Push และใช้งานร่วมกันกับผู้อื่น เพราะอาจนำไปสู่การเกิด Conflicts ได้

หาก Commit ยังไม่ได้ถูก Push หรือหากคุณกำลังทำงานอยู่ใน Local Repository คุณสามารถ Push Commit ที่ถูกแก้ไขแล้ว โดยใช้คำสั่งต่อไปนี้:

หมายเหตุ: โปรดใช้ความระมัดระวังเมื่อมีการใช้ --force Option เนื่องจากมันจะทำการเขียนทับ Remote Branch ด้วย Local Changes ของคุณ และอย่าลืมที่จะสื่อสารกับสมาชิกในทีมของคุณ ก่อนที่จะใช้ Option นี้

ขั้นตอนทั้งหมดมีเพียงเท่านี้! และตอนนี้คุณก็ได้เรียนรู้วิธีใช้งาน Git Amend เพื่อแก้ไข Commit Message เรียบร้อยแล้ว

ทำไม Commit Messages ที่สื่อความหมายชัดเจน ถึงได้มีความสำคัญ

Commit Messages ที่สื่อความหมายได้อย่างชัดเจน มีความสำคัญอย่างมากใน Version Control Systems อย่าง Git ด้วยเหตุผลต่าง ๆ ดังต่อไปนี้:

1. การสื่อสาร

Commit Messages ทำหน้าที่เป็นเหมือนแบบฟอร์มในการสื่อสารระหว่าง Developers ด้วยกัน เมื่อต้องทำงานร่วมกันใน Project การใช้ Commit Messages ที่ชัดเจนและสื่อความหมายได้ถูกต้อง จะช่วยทำให้สมาชิกในทีมมีความเข้าใจในวัตถุประสงค์และเจตนาที่อยู่เบื้องหลังของ Changes ที่ทำต่อ Codebase

2. การทำความเข้าใจกับ Changes ที่เกิดขึ้น

Commit Messages จะช่วยทำให้เกิดความชัดเจนเกี่ยวกับ Changes ที่เกิดขึ้นกับแต่ละ Commit พวกมันจะช่วยตอบคำถามต่าง ๆ เช่น ทำไม Change ถึงได้เกิดขึ้น, ปัญหาที่ต้องการจะแก้ไข และมันกระทบต่อ Codebase อย่างไรบ้าง

3. การ Debug และการ Track ปัญหาที่เกิดขึ้น

เมื่อเจอ Bug หรือปัญหาใดก็ตาม Commit Messages สามารถให้ข้อมูลที่สำคัญสำหรับการ Debug และการ Track แหล่งที่มาของปัญหาได้ การตรวจสอบ Commit Messages จะช่วยให้ Developers สามารถระบุ Changes ส่วนที่อาจก่อให้เกิด Bug หรือสิ่งที่ทำให้เกิดปัญหาได้ ซึ่งทำให้การหาสาเหตุและแก้ไขปัญหา ทำได้ง่ายและสะดวกยิ่งขึ้น

4. Documentation และการอ้างอิงถึง History

Commit Messages ถือเป็นรูปแบบอย่างหนึ่งของ Documentation สำหรับ History ของ Project มันมีการจัดทำบันทึกของ Changes ที่เกิดขึ้นทั้งหมดกับ Codebase เรียงตามลำดับเวลา ซึ่งจะทำให้เราได้เห็นถึงพัฒนาการของ Project ตามลำดับ เมื่อเวลาผ่านไป

5. การ Maintain Code และการส่งมอบการ Maintain

Commit Messages ที่ได้รับการออกแบบหรือถูกคิดมาเป็นอย่างดีแล้ว จะช่วยให้การ Maintain Code จัดการได้ง่ายขึ้น เมื่อต้องดูแล Project เหล่า Developers จะสามารถอ้างอิงถึง Commit Messages เพื่อทำความเข้าใจเหตุผลที่อยู่เบื้องหลังของ Changes ในครั้งก่อน ๆ และสามารถตัดสินใจได้อย่างรอบคอบหากจะมีการปรับปรุงแก้ไขสิ่งใดเพิ่มเติมในอนาคต

สรุป

Git Amend เป็นเครื่องมือทรงพลังที่สามารถช่วยให้ Developers สามารถแก้ไข Commit Messages และปรับปรุงในเรื่องความชัดเจนและความถูกต้องของ Version Control History ได้ แต่อย่างไรก็ตาม สิ่งสำคัญคือ คุณควรใช้ Git Amend อย่างรอบคอบ แม้ว่าการแก้ไขข้อผิดพลาดเล็ก ๆ น้อย ๆ หรือเพิ่มรายละเอียดส่วนที่ขาดหายไป อาจเป็นประโยชน์ต่อการทำงาน แต่การใช้ Git Amend ที่มากจนเกินไป ก็อาจทำให้เกิดความสับสนและทำลายความสมบูรณ์ของ Commit History ได้เช่นกัน ดังนั้น คุณควรทำทุกอย่างด้วยความสมดุลและพอเหมาะพอควร

ที่มาhttps://www.freecodecamp.org/

 

 

รับตำแหน่งงานไอทีใหม่ๆ ด้วยบริการ IT Job Alert

 

อัพเดทบทความจากคนวงในสายไอทีทาง LINE ก่อนใคร
อย่าลืมแอดไลน์ @techstarth เป็นเพื่อนนะคะ

เพิ่มเพื่อน

 

บทความล่าสุด