Cover image

Git commit message convention เขียน git commit message ให้เข้าใจง่าย

15 Jun 2022

Share to:

สวัสดีครับ บทความนี้เราจะมาเรียนรู้การเขียน Git commit message อย่างไรให้เข้าใจง่ายกันนะครับ (git commit message convention)

สําหรับ Git commit message convention เราะจะใช้รูปแบบการเขียน Commit เป็นแบบนี้ครับ

<type>(<scope>): <subject>
<optional body>

เรามาดูไปทีละส่วนดังนี้ครับ

<type>

เป็นประเภทสิ่งที่เราแก้ไขครับ ส่วนใหญ่จะแบ่งเป็นดังนี้ครับ

  • build: เป็นการแก้ไขส่วนที่เกี่ยวข้องกับการ Build (เช่น แก้ไข Docker file, Build script)
  • chore: เป็นการแก้ไขที่ไม่เห็นจากข้างนอก (เช่น การปรับ .gitignore, .prettierrc file ฯลฯ)
  • feat: การเพิ่ม Feature
  • fix: การแก้ไข Bug ต่างๆ
  • docs: การแก้ไขที่เกี่ยวข้องกับเอกสาร
  • refactor: คือการ Refactor code
  • perf: คือการปรับปรุงประสิทธิภาพของ Application
  • test: เกี่ยวข้องกับการ Test เช่น แก้ไข Test case

<scope>

ส่วนนี้จะเป็นส่วนที่บอกว่าสิ่งที่เราแก้ไขนั้นไปเกี่ยวข้องกับส่วนไหนของโปรแกรมของเรา โดยปกติจะเป็นคำนาม ซึ่งจะมีหรือไม่มีก็ได้ครับ เช่น

  • frontend
  • backend
  • controller
  • middleware
  • web-server

<subject>

เป็นส่วนอธิบายว่า Commit นี้เราแก้ไข หรือทําอะไรไป

<optional body>

เป็นคําอธิบายเพิ่มเติมครับ ตรงนี้จะมีหรือไม่มีก็ได้ครับ

ตัวอย่างการเขียน Commit message

ถ้าเรามีการแก้ไข bug รูปภาพในหน้า Home page จะได้ Commit message ประมาณนี้ครับ

fix(view): correct image in home page

ถ้าเราเพิ่ม Feature ในส่วน controller จะได้ Commit message ประมาณนี้ครับ

feat(controller): add new upload feature

ก็ประมาณนี้ครับสําหรับ Git commit message convention ลองนําไปปรับใช้งานดูนะครับ


Copyright © 2019 - 2024 thiti.dev |  v1.29.0 |  Privacy policy |  status | 

Github profile   Linkedin profile   X profile   Youtube channel   Telegram   Email contact   วงแหวนเว็บ