Branch & PR Naming Convention
Branch Naming
หัวข้อที่มีชื่อว่า “Branch Naming”[type]/[short-description]ประเภท Branch
หัวข้อที่มีชื่อว่า “ประเภท Branch”| Type | ใช้เมื่อ | ตัวอย่าง |
|---|---|---|
feature/ | พัฒนาฟีเจอร์ใหม่ | feature/user-registration |
bugfix/ | แก้บัค | bugfix/BUG-012-submit-button |
hotfix/ | แก้ไขเร่งด่วน (production) | hotfix/fix-login-crash |
test/ | เพิ่ม test | test/add-auth-unit-tests |
refactor/ | refactor code | refactor/cleanup-api-routes |
PR Title
หัวข้อที่มีชื่อว่า “PR Title”[TYPE] คำอธิบายสั้นๆตัวอย่าง
หัวข้อที่มีชื่อว่า “ตัวอย่าง”| PR Title | อธิบาย |
|---|---|
[FEATURE] เพิ่มระบบสมัครสมาชิก | ฟีเจอร์ใหม่ |
[BUGFIX] BUG-012: แก้ปุ่ม Submit ไม่ทำงาน | แก้บัค |
[HOTFIX] แก้ login crash บน production | แก้ไขเร่งด่วน |
[TEST] เพิ่ม unit test สำหรับ auth module | เพิ่ม test |
[REFACTOR] ปรับปรุง API route structure | refactor |
Commit Message
หัวข้อที่มีชื่อว่า “Commit Message”[type]: คำอธิบายตัวอย่าง
หัวข้อที่มีชื่อว่า “ตัวอย่าง”feat: เพิ่มฟอร์มสมัครสมาชิกfix: แก้ปุ่ม submit ไม่ทำงาน (BUG-012)test: เพิ่ม unit test สำหรับ registrationrefactor: ปรับปรุง error handling ใน APIdocs: อัพเดท plan.md เพิ่ม API specsGit Workflow
หัวข้อที่มีชื่อว่า “Git Workflow”main (production) └── feature/user-registration ├── commit: feat: เพิ่มฟอร์ม registration ├── commit: test: เพิ่ม unit test └── commit: fix: แก้ validation error → PR → Review → Merge to mainขั้นตอน
หัวข้อที่มีชื่อว่า “ขั้นตอน”- สร้าง branch จาก
main - พัฒนา และ commit บ่อยๆ
- สร้าง PR ตาม เทมเพลต PR
- Review (DEV review สำหรับ PR ของ INTERN)
- Merge เข้า
main(squash merge)