📚 Quy Tắc Đặt Tên Branch (Git Naming Convention)
Để đảm bảo rõ ràng, thống nhất và dễ quản lý trong quá trình phát triển phần mềm, team áp dụng quy tắc đặt tên branch như sau:
📌 1. Cấu trúc chung:
<loại-công-việc>/<mô-tả-ngắn>-<taskID-tuỳ-chọn>
Ví dụ:
feature/add-login-page-123
bugfix/fix-signup-error-456
hotfix/crash-on-startup
release/v1.2.0
refactor/clean-dashboard-code
📌 2. Loại công việc (Prefix):
| Prefix | Dùng khi nào |
|---|---|
feature/ |
Thêm chức năng mới |
bugfix/ |
Sửa lỗi nhỏ trong quá trình dev |
hotfix/ |
Sửa lỗi khẩn cấp từ production hoặc staging |
refactor/ |
Tối ưu, dọn dẹp code, không làm thay đổi tính năng |
release/ |
Chuẩn bị bản phát hành chính thức |
test/ |
Viết hoặc thay đổi test code |
chore/ |
Việc phụ: update config, document, CI/CD... |
📌 3. Nguyên tắc mô tả nhánh:
-
Chỉ dùng chữ thường, không dấu, không khoảng trắng
-
Dùng
-để phân cách các từ -
Mô tả ngắn gọn, rõ ràng về mục đích nhánh
-
Có thể thêm
IDcủa task trong Trello/Jira nếu có
✅ Ví dụ chuẩn:
-
feature/create-user-profile-298 -
bugfix/remove-duplicate-rows-842 -
hotfix/stripe-payment-timeout -
refactor/optimize-image-loading -
chore/update-eslint-config
🚫 Tránh đặt tên kiểu:
-
newbranch❌ -
fix123❌ -
tính-năng/thêm người dùng❌
🛠 Mẹo dùng trong Visual Studio:
Khi tạo branch mới trong Visual Studio, bạn có thể dán luôn tên theo format chuẩn như:
feature/handle-login-error-1092
Visual Studio sẽ tạo và checkout nhánh đó cho bạn.
Aucun commentaire:
Enregistrer un commentaire