Bạn đã bao giờ gặp khó khăn khi đọc hiểu commit message của dự án Git? Hay bạn cảm thấy khó khăn trong việc viết commit message rõ ràng và súc tích? Bài viết này Stringee sẽ giới thiệu các quy tắc đơn giản giúp bạn viết commit message chất lượng, giúp bạn và các thành viên trong nhóm dễ dàng theo dõi lịch sử thay đổi của dự án.

1. Cách commit hiệu quả

Quan sát 2 cách commit sau để thấy rõ sự khác biệt:

Cách commit không hiệu quả:

git commit -m "fix bug"
git commit -m "add new feature"
git commit -m "update code"

Với cách commit này, bạn có thể thấy rất khó để biết những commit này đang diễn tả hành động gì.

Cách commit hiệu quả:

git commit -m "Fixed image display bug on homepage"
git commit -m "Added Facebook login feature"
git commit -m "Updated ReactJS library to the latest version"

Sự khác biệt:

Cách commit hiệu quả sử dụng mô tả rõ ràng và cụ thể cho từng commit.

Sử dụng động từ ở đầu mô tả để tóm tắt hành động chính của commit.

Sử dụng tiếng Anh để viết commit message, giúp mọi người dễ dàng hiểu được.

Với ví dụ trên chắc hẳn bạn đã hiểu được phần nào về ý nghĩa của việc commit đúng cách là như thế nào rồi đúng không? Đừng dừng lại, hãy đọc tiếp để nắm được cách commit sao cho chuẩn và dễ hiểu nhất.

2. Tầm quan trọng của commit message

Ghi chú commit đóng vai trò quan trọng trong việc ghi lại lịch sử thay đổi của dự án Git. Một commit message tốt sẽ giúp bạn và nhóm của bạn:

Dễ dàng hiểu được nội dung thay đổi: Ghi chú commit rõ ràng giúp người đọc hiểu được "cái gì" đã thay đổi và "tại sao" thay đổi được thực hiện.

Tìm kiếm commit sau này: Việc sử dụng từ khóa và cấu trúc hợp lý giúp bạn dễ dàng tìm kiếm commit cụ thể khi cần thiết.

Cải thiện khả năng quản lý phiên bản code: Ghi chú commit chất lượng giúp bạn theo dõi lịch sử thay đổi và quản lý phiên bản code hiệu quả hơn.

>>> Xem thêm các bài viết hay tại đây

Github là gì? Hướng dẫn sử dụng Github cho người mới bắt đầu

DNS là gì? Các loại DNS phổ biến và cách sử dụng

Hướng dẫn cài đặt Apache, PHP và MySQL trên Windows

3. Các quy tắc khi viết Commit

Phân biệt chủ đề và nội dung

Sử dụng một dòng trắng để phân biệt chủ đề và nội dung commit message. Chủ đề nên ngắn gọn, súc tích và mô tả tóm tắt nội dung thay đổi. Nội dung commit nên cung cấp thông tin chi tiết về các thay đổi được thực hiện.

Ví dụ:

Chủ đề: Cập nhật README
Nội dung:
- Thêm thông tin về cài đặt
- Sửa lỗi chính tả

Giới hạn độ dài chủ đề

Giới hạn độ dài chủ đề commit trong 50 ký tự để đảm bảo tính ngắn gọn và hiển thị đầy đủ trên nhiều giao diện Git khác nhau.

Ví dụ:

Cập nhật README

// Thay vì

Cập nhật README và sửa lỗi chính tả

Viết hoa chữ cái đầu tiên của chủ đề

Viết hoa chữ cái đầu tiên của chủ đề commit giúp tăng tính dễ đọc và chuyên nghiệp.

Ví dụ:

Cập nhật README

// Thay vì

cập nhật readme

Không sử dụng dấu chấm ở cuối chủ đề

Tránh sử dụng dấu chấm ở cuối chủ đề commit vì nó có thể gây nhầm lẫn cho một số công cụ Git.

Ví dụ:

Cập nhật README

// Thay vì

Cập nhật README.

Sử dụng động từ ở dạng mệnh lệnh

Sử dụng động từ ở dạng mệnh lệnh trong chủ đề commit để mô tả rõ ràng hành động được thực hiện.

Ví dụ:

Cập nhật README

// Thay vì

README đã được cập nhật

Giới hạn độ dài nội dung

Giới hạn độ dài nội dung commit trong 72 ký tự mỗi dòng để đảm bảo tính dễ đọc và khả năng hiển thị trên nhiều giao diện khác nhau.

Giải thích "cái gì" và "tại sao" thay vì "như thế nào"

Sử dụng nội dung commit để giải thích "cái gì" đã thay đổi và "tại sao" thay đổi được thực hiện. Tránh tập trung vào "như thế nào" thay đổi được thực hiện vì thông tin này có thể được tìm thấy trong mã nguồn.

Ví dụ:

Cập nhật README
- Thêm thông tin về cài đặt để giúp người dùng dễ dàng cài đặt dự án hơn.
- Sửa lỗi chính tả để nâng cao tính chuyên nghiệp của dự án.

Thay vì:

Cập nhật README
- Thay đổi nội dung cài đặt
- Sửa lỗi "lỗi chính tả" trong README

Mẹo bổ sung:

Sử dụng các từ khóa để dễ dàng tìm kiếm commit sau này.

Sử dụng dấu gạch ngang (-) để tạo danh sách các thay đổi.

Sử dụng ký tự # để đánh dấu các vấn đề hoặc nhiệm vụ cần thực hiện.

Tham khảo các commit trước đây để đảm bảo tính nhất quán.

Tổng kết

Git commit là một công cụ quan trọng giúp bạn quản lý source code hiệu quả. Hãy tập thói quen commit thường xuyên với nội dung rõ ràng để giúp bạn và những người khác dễ dàng theo dõi lịch sử thay đổi và cộng tác hiệu quả hơn.

>>> Xem thêm các bài viết tại đây:

NVM là gì? Cách cài đặt và sử dụng NVM

DevOps Là Gì? Những Kỹ Năng Cần Thiết Để Trở Thành DevOps

Tìm hiểu về Unix/Linux là gì? Ưu điểm và nhược điểm của Unix/Linux

Stringee Communication APIs là giải pháp cung cấp các tính năng giao tiếp như gọi thoại, gọi video, tin nhắn chat, SMS hay tổng đài CSKH cho phép tích hợp trực tiếp vào ứng dụng/website của doanh nghiệp nhanh chóng. Nhờ đó giúp tiết kiệm đến 80% thời gian và chi phí cho doanh nghiệp bởi thông thường nếu tự phát triển các tính năng này có thể mất từ 1 - 3 năm.

Bộ API giao tiếp của Stringee hiện đang được tin dùng bởi các doanh nghiệp ở mọi quy mô, lĩnh vực ngành nghề như TPBank, VOVBacsi24, VNDirect, Shinhan Finance, Ahamove, Logivan, Homedy, Adavigo, bTaskee…

Quý bạn đọc quan tâm xin mời đăng ký NHẬN TƯ VẤN TẠI ĐÂY: