Commit Message - konlawatit/SWDEV-BBP-PLUS GitHub Wiki

คือข้อความที่ทีมตกลงร่วมกันในการ commit แต่ละครั้งว่ามี commit subject และ description มีรูปแบบอย่างไรเพื่อให้เข้าใจตรงกันว่า commit นั้นทำอะไรไปบ้าง

Structure

Commit Subject:

[type] <title>
  • type คือส่วนที่บอกประเภทของ commit นั้นๆ
  • title คือชื่อของ commit ที่บ่งบอกว่าทำหน้าอะไร
  • โดยส่วนของ title จำเป็นต้องมีการอธิบายหน้าที่อย่างชัดเจน ตัวอย่าง: [UI] create login form

Commit Description:

  • เป็นส่วนที่บอกรายละเอียดของ commit นั้นๆโดยละเอียด

Commit

โดยในโปรเจคนี้ จะมี commit types ทั้งหมดดังต่อไปนี้
[UI]       : ใช้สำหรับการจัดการที่เกี่ยวข้องกับ UI ทั้งหมด
[FIX]      : ใช้สำหรับแก้ไข Bug หรือแก้ไขตาม spec ใหม่
[REFACTOR] : ใช้เมื่อมีการปรับปรุง Code เก่าที่เคยเขียนไว้แล้วให้ดียิ่งขึ้น
[CHORE]    : ใช้สำหรับการจัดการเล็กๆเหมือนงานบ้านเช่น เปลี่ยนชื่อตัวแปร, เปลี่ยนชื่อ page 
[LOGIC]    : ใช้สำหรับการจัดการเกี่ยวกับด้าน logic ต่างๆฟังก์ชันต่างๆ
[DESC]     : ใช้เมื่อใน commit นั้นมีการทำหลายๆอย่างรวมกันซึ่งอาจระบุไม่ได้แน่ชัดว่าอยู่ใน type ไหนและจะลงรายละเอียดใน commit description เพิ่มเติม
⚠️ **GitHub.com Fallback** ⚠️