เขียน Git Commit Message ให้อ่านแล้ว เข้าใจง่ายกันดีกว่านะ
1 min readMar 22, 2021
อ่านง่าย เข้าใจง่าย ในแนวทางเดียวกัน แบบนี้ใคร ๆ ก็ชอบ
Note: รวบรวมมาจากหลายแหล่ง หลายคน และพยายามทำเองด้วย
ข้อความแบบนี้
หน้าตาของ Git Commit Message แบบที่น่าจะเป็น คือ
<type>(<scope>): <subject>
<optional body>อธิบาย
<type>
ที่นิยมใช้กันก็คือ
- build: อะไรก็ตามที่มันเกี่ยวกับการ Build (เช่น คำสั่ง npm หรือการเพิ่ม External Dependencies หรืออาจจะเป็นการปรับ Dockerfile ก็ได้)
- chore: อะไรก็ตามที่ไม่เห็นจากข้างนอก (เช่น การปรับ .gitignore หรือ .prettierrc file เป็นต้น)
- feat: A new feature 😏
- fix: A bug fix 😎
- docs: อะไรก็ตาม ที่เกี่ยวกับการปรับเอกสาร
- refactor: ก็คือทำ Refactor อ่ะ ตรง ๆ
- perf: อะไรก็ตาม ที่เกี่ยวกับการปรับปรุงประสิทธิภาพของตัว Application
- test: อะไรก็ตาม ที่เกี่ยวกับการทดสอบ (อาจจะเป็นการทำ Test Case เพิ่ม หรือปรับปรุงก็ได้)
อาจจะมีอะไรที่นอกเหนือไปจากนี้ก็ได้ แต่ก็ควรจะเป็นคำที่เข้าใจได้ทั้นที
<scope>
จะมีหรือไม่มีก็ได้ ควรเป็นคำนาม ที่สามารถบอกได้ว่า Commit นี้ไปโดนอะไรบ้าง เช่น
- init
- runner
- watcher
- config
- controller
- middleware
- web-server
- proxy
- frontend
- backend
<subject>
บอกตรง ๆ เลยว่า Commit นี้ทำอะไร 1 อย่างก็พอ ถ้าสิ่งที่อยากบอก มันมีมากกว่า 1 อย่าง ก็น่าจะแปลว่า Commit นี้ ใหญ่เกินไปแล้ว
ตัวอย่าง
ปรับ Document
docs: correct spelling of CHANGELOGปรับแก้ปัญหา Code (ในส่วน Controller)
fix(controller): correct minor typosปรับแก้ปัญหา Code (ในส่วน View)
fix(view): correct image loading behaviour
from auto to lazyเพิ่ม Feature (ในส่วน Middleware)
feat(middleware): add authen for users resource
