Đây là các quy ước thống nhất khi làm việc với git, để thuận tiện cho việc theo dõi và nhận thức được các công việc thực hiện trên mỗi nhánh code. Để cho gọn, ta chỉ tập trung vào các công việc thường gặp nhất.
| Tên nhánh | Quy ước đặt tên | Ghi chú |
|---|---|---|
| Stable | stable | Nhánh ổn định: Chỉ chấp nhận các yêu cầu merge (PR) từ nhánh Working và các nhánh Hotfixes (không code trực tiếp trên nhánh này). |
| Working | master | Nhánh phát triển: Chỉ chấp nhận các yêu cầu merge (PR) từ nhánh các nhánh Features/Issues, Bugfixes và Hotfixes (không code trực tiếp trên nhánh này). |
| Features/Issues | dev-*, feat-*, topic-* | Luôn rẽ từ ngọn (HEAD) của nhánh Working |
| Bugfix | bugfix-* | Luôn rẽ từ nhánh Stable, kết thúc nhánh sẽ được merge về stable và master |
| Hotfix | hotfix-* | Luôn rẽ từ nhánh Stable, kết thúc nhánh sẽ được merge về stable và master |
Một repository sẽ luôn có 2 nhánh chính hoạt động:
master- nhánh phát triển luôn chứa mã nguồn mới nhất cho bản phát hành tiếp theo.stable- nhánh ổn định mới nhất đã triển khai cho khách hàng. Trong quá trình phát triển hàng ngày, nhánh này sẽ không được tương tác.
Khi mã nguồn trên nhánh master được xem xét là ổn định và được triển khai thật, thì tất cả các thay đổi trên nhánh này sẽ được merge vào nhánh stable và tag với 1 số phiên bản phát hành mới. Điều này được thực hiện thế nào sẽ được thảo luận sau.
Các nhánh hỗ trợ thường được sử dụng để hỗ trợ phát triển song song giữa các thành viên trong nhóm, dễ dàng theo dõi các tính năng đang được phát triển và hỗ trợ khắc phục các sự cố nóng sau khi đã triển khai. Không giống các nhánh chính, các nhánh này có thời gian sống ngắn và bị hạn chế, chúng có thể bị xóa bất cứ lúc nào sau khi nó hoàn tất nhiệm vụ.
Các nhánh này bao gồm:
- Features branches
- Nhánh có chức năng phát triển các tính năng mới và được cập nhật trong giai đoạn 1 (3-5 ngày), giai đoạn 2 (5-10 ngày), giai đoạn 3 (10-30 ngày), giai đoạn 4 (31-60 ngày).
- Mã hiệu tên nhánh:
dev-*,feat-*, hoặctopic-* - Mức độ ưu tiên:
3 - Chỉ số semver: MAJOR, MINOR
- Bugfix brances
- Nhánh thực hiện sửa lỗi các chức năng hệ thống, có thời gian thực hiện và cập nhật bản vá từ 3 - 5 ngày.
- Mã hiệu tên nhánh:
bugfix-* - Mức độ ưu tiên:
2 - Chỉ số semver: MINOR, PATCH
- Hotfix brances
- Nhánh thực hiện các chỉnh sửa và cập nhật ngay cho khách hàng, thời gian xử lý trong vòng 2 ngày.
- Mã hiệu tên nhánh:
hotfix-* - Mức độ ưu tiên:
1 - Chỉ số semver: PATCH
Mỗi nhánh này có một mục đích cụ thể và có ràng buộc nghiêm ngặt, như: được rẽ từ nhánh nào và sẽ được merge vào nhánh đích nào. Sau khi kết thúc mã nguồn dự án sẽ được đánh phiên bản theo quy ước semver: MAJOR.MINOR.PATCH.
Việc rẽ nhánh cần chọn tên ngắn và có mô tả
# good
$ git checkout -b dev-oauth-migration
# bad
$ git checkout -b login_fix