GitHướng Dẫn

Một số quy tắc cơ bản để đặt tên branch và viết commit message trong một dự án sử dụng GIT làm việc nhóm

Quy tắc đặt tên branch

  1. Tên branch nên được viết thườngkhông có khoảng trắng.
  2. Tên branch nên mô tả một cách rõ ràngngắn gọn nội dung của branch đó.
  3. Tên branch nên bắt đầu bằng từ "feature/" hoặc "bugfix/" tương ứng với tính năng hoặc sửa lỗi.
  4. Tên branch nên được đặt dựa trên ticket hoặc issue liên quan để dễ dàng theo dõi và tìm kiếm.

Ví dụ, nếu bạn đang làm việc trên tính năng "Thêm sản phẩm vào giỏ hàng" và mã ticket tương ứng là "SPGH-123", bạn có thể đặt tên branch là "feature/SPGH-123-add-to-cart". Tên này sẽ rõ ràng, mô tả nội dung của branch và có thể dễ dàng tìm kiếm trong trường hợp cần thiết.

Quy tắc viết commit message

  1. Độ dài commit message nên trong khoảng 50-72 ký tự.
  2. Commit message nên bắt đầu bằng một động từ nguyên mẫu (ví dụ: Add, Update, Fix, Remove, Refactor, etc.)
  3. Nội dung commit message nên mô tả chi tiết và đầy đủ những thay đổi đã được thực hiện.
  4. Sử dụng chữ viết hoa cho ký tự đầu tiên của từ đầu tiên trong commit message.
  5. Tránh sử dụng các dấu câu không cần thiết và tránh sử dụng chữ viết hoa toàn bộ câu.
  6. Sử dụng mã số liên kết tới các công việc hoặc yêu cầu liên quan nếu có.
  7. Sử dụng ngôn ngữ bằng tiếng Anh, tránh sử dụng tiếng lóng hoặc quá đơn giản.

Ví dụ: "Add new feature to allow user to reset password" hoặc "Fix bug causing login to fail on certain devices".

→ Xem thêm: Một quy trình để phát triển một tính năng trong 1 dự án có sử dụng GIT

Bài viết liên quan

Trả lời

Email của bạn sẽ không được hiển thị công khai. Các trường bắt buộc được đánh dấu *

Back to top button
Close