Trong những vấn đề thường gặp của một Developer ít kinh nghiệm khi làm việc cùng team, Git Commit dường như là một câu chuyện có thể kể nhau nghe cả đêm.
Git Commit là gì?
Là một trong những dòng lệnh khi sử dụng Git Terminal (không có GUI, tức không có giao diện để quản lý bằng cách nhấn chuột vào và nó làm việc).
Câu lệnh thường thấy:
git commit -m "Commit Name"
Nhiệm vụ của biến -m (message) thường là cung cấp thông tin về commit. Commit nằm trong chuỗi thì phải có tên hay cái gì đó để phân biệt khi tiến hành review chứ, đúng không?
Tại sao bạn cần trở thành một quý ông khi dùng Git Commit?
Câu hỏi hay! Rất nhiều developer gặp một lỗi sơ đẳng khi sử dụng Git là không viết câu cú tiếng Anh đúng cú pháp, cung cấp thiếu thông tin, viết sai chính tả,… Những lỗi này rõ ràng một quý ông (hay quý bà) không nên gặp phải trong thời đại ngày nay.
Git Commit tốt thì có lợi gì?
Một commit là tốt không thể chỉ bởi có dòng code tốt, mà nó còn phải giúp người khác (như người review code, hoặc khách hàng) hiểu bạn đang làm gì mà không phải vào lục lọi code bạn đã làm.
Git Commit với nội dung theo đúng tiêu chuẩn sẽ giúp:
- Giảm thời gian đánh giá từ người review.
- Giúp tổng hợp và cập nhật phiên bản tốt hơn (cho mảng production).
- Dễ dàng tracking lại các vấn đề đã xử lý
Làm thế nào để Git Commit chuẩn không cần chỉnh?
[sociallocker]
Đầu tiên, dù bạn làm việc cá nhân hay với đội nhóm, hãy thiết lập các quy ước về sử dụng Git, đặc biệt là cú pháp cho mỗi lần commit.
Từ kinh nghiệm thực tiễn những dự án đã triển khai, dưới đây là các quy ước bạn nên cân nhắc để trở thành một quý ông/quý bà lịch thiệp trong những commit bạn đưa lên:
Viết với độ dài phù hợp, tối đa không quá 50 từ.
Commit ID
ID – Bắt đầu bằng một số có thể theo dõi (tracking number), ví dụ như mã số ticket của vấn đề, hoặc số ngày tháng năm theo tiêu chuẩn DDMMYY.
Động từ nguyên thể
Verb – Tiếp theo là một động từ ở thì hiện tại. Các động từ phổ biến có thể dùng:
- Add
- Fix
- Change
- Create
- Build
- Clear
- Delete
Đối tượng
Object – Tiếp theo là một tổ hợp bổ sung đối tượng của hành động. Trong phần lớn trường hợp thì đó thường là một element trên web, thuộc tính của đối tượng,…
- Fix spacing
- Update typography
- Clear wrong text
- Delete duplicate line
Trạng ngữ
Tiếp theo là tới phần mô tả vị trí mà chúng ta đã thay đổi. Thường phần này rất nhiều developer bỏ qua dẫn tới commit có tiêu đề cụt lủn, rất khó chịu với người review. Ví dụ:
- Fix spacing between cards on grid
- Update typography in header menu item
- Clear wrong text in footer widget
- Delete duplicate line in sidebar
Nên liệt kê cụ thể hai vị trí
- Vị trí phần nội dung trong page
- Vị trí page trong website
Chẳng hạn: mục Footer của page About Us
Commit Status
Cuối cùng, nên đưa thêm các thông tin về vấn đề đã xử lý, cụ thể là status (Trạng thái):
Nếu bạn có commit chưa hoàn thành nhưng cần đưa lên, thêm “(WIP)” vào sau cùng commit title (tức là Work In Progress – đang làm dở). Ví dụ:
git commit -m "CODETOT-23 Fix global button typography (WIP)"
Nếu bạn có một công việc lớn cần chia nhỏ ra thành các commit để dễ tracking, hãy thêm “(cont.)” Ví dụ:
git commit -m "CODETOT-32 Fix header spacing in tablet (cont.)" git commit -m "CODETOT-32 Fix header spacing in mobile (cont.)"
Nếu commit cuối cùng đã kết thúc chuỗi công việc, bạn có thể thêm “(done)” vào cuối như thế này:
git commit -m "CODETOT-32 Fix Header spacing in desktop (done)"
[/sociallocker]
Kết luận
Có rất nhiều người bị đánh giá sai về kết quả công việc đã làm bởi việc sử dụng Git Commit kém chuyên nghiệp. Đừng trở thành một người như vậy trong mắt các đồng nghiệp. Hãy trở thành một người lịch sự trong Git Commit, và bạn sẽ cảm nhận sự chuyên nghiệp trong những gì bạn làm.
Giám đốc tại Công ty CP CODE TỐT. Quản lý ngôn ngữ bản địa tiếng Việt tại WordPress. Là tác giả chính tại codetot.net, Khôi muốn ghi lại một sốvấn đề kỹ thuật trong quá trình phát triển các dự án website với khách hàng.
