© 2020, Developed by Hieu Dev

Đặt tên commit message Github sao cho đúng cách

Khi bạn làm việc với Github, thì sẽ quá quen thuộc với workflow và các command thông dụng. Nhưng sau khi bạn làm việc nhiều hoặc làm việc với dự án thực tế hơn thì bạn cần tuân theo các quy tắc naming commit message nhất định, nhưng không nhất thiết là bạn phải luôn tuân theo bộ quy tắc này, nhưng những dự án khác nhau, thì các quy tắc linh động khác nhau. 

Đặt tên commit message Github sao cho đúng cách


Cấu trúc của commit message

Conventional commits là một bộ quy tắc viết commit message sinh ra với mục đích để cả người đọc được và các công cụ máy tính có thể tìm kiếm. Nó cung cấp một bộ quy tắc dễ dàng để tạo lịch sử commit rõ ràng.

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]


Trong đó:
  • Dựa vào các kí tự, bạn có thể dễ dàng biết được phần nào là bắt buộc và không bắt buộc. Các thành phần type, description là bắt buộc cần có trong commit message, optional là tùy chọn có hoặc không có cũng được.

Type

Trước tiên, chúng ta sẽ đề cập đến phần type, chúng nằm ở đầu commit message nên khi bạn xem lại các lại lịch sử commit sẽ thấy project sẽ chuyên nghiệp hơn rất nhiều, ngoài ra nó còn đánh dấu được là bạn đang commit những gì để cho các PM, tech lead,... dễ dàng review code của bạn. 

Cụ thể, ta có nhưng quy tắc commit chung cho phần type như sau:
  • fix: tiền tố này thực hiện fix bug của dự án
  • feat (feature): tiền tố này thực hiện một chức năng mới của dự án
  • refactor: tiền tố này thực hiện refactor lại code hiện tại của dự án (refactor hiểu đơn giản là việc "làm sạch" code, loại bỏ code smells, mà không làm thay đổi chức năng hiện có)
  • docs: tiền tố này thực hiện thêm/sửa đổi document của dự án
  • style: tiền tố này thực hiện thay đổi UI của dự án mà không ảnh hưởng đến logic.
  • perf: tiền tố này thực hiện cải thiện hiệu năng của dự án (VD: loại bỏ duplicate query, ...)
  • vendor: tiền tố này thực hiện cập nhật phiên bản cho các packages, dependencies mà dự án đang sử dụng.
  • chore: tiền tố này chỉ những thay đổi không đáng kể, lặt vặt trong code (ví dụ như thay đổi text chẳng hạn).

Description

Phần description này rất quan trọng và biết bạn đang làm gì với commit này, nhưng đảm bảo bạn phải mô tả khái quát, ngắn gọn về những thay đổi được thực hiện trong pull request.

Như vậy, trong commit cho phần description, ta cũng có những quy tắc chung như sau:
  • Tách tiêu đề với phần thân của nội dung commit bằng một dòng trắng
  • Tiêu đề giới hạn 50 ký tự
  • Viết hoa chữ cái đầu ở dòng tiêu đề
  • Không kết thúc tiêu đề bằng dấu chấm
  • Sử dụng câu mệnh lệnh trong tiêu đề
  • Giới hạn 72 ký tự mỗi dòng ở phần thân của nội dung commit
  • Trả lời câu hỏi điều gì, tại sao và như thế nào ở phần thân của nội dung commit

Tham khảo


Lời kết

Đó là những quy tắc cơ bản để viết commit message, nhưng những quy tắc đó ở những công ty, dự án khác nhau, sẽ được điều chỉnh lại khác nhau. Khi mới làm quen, có thể nó hơi lằng nhằng, tuy nhiên nếu sử dụng thường xuyên thì nó bạn sẽ quen và nhớ thôi. 

By Hieu Ho

Đăng nhận xét

Mới hơn Cũ hơn