Bạn đang viết commit message như thế nào?

3907
viết commit message như thế nào

Giới thiệu

Ngày hôm nay mình sẽ viết lách một chút với một topic không mấy liên quan tới code nhưng lại khá thực tiễn trong công việc lập trình đó là việc viết commit message như thế nào cho đúng? – Một trong số những thứ mà chúng ta không được dạy khi còn trên ghế nhà trường.

Thực ra là không có cách viết nào là đúng và cũng không có cách viết nào là sai cả. Tuy nhiên, nếu trong một project mỗi người viết commit message một kiểu thì khi nhìn vào commit history nó cũng không trông đẹp mắt.

Chưa kể khi cần chúng ta phải tìm kiếm và xem lại commit trong đống commit của vài tháng trước đó thông qua các commit message mà không có bất cứ quy tắc nào.

Đây sẽ là vấn đề khi mình giả định:

  • Đọc commit message mà không phán đoán được commit đấy sinh ra với mục đích gì.
  • Cần tóm lược các thay đổi trong source code khi release sau một khoảng thời gian phát triển.
  • Lựa chọn version mới phù hợp v1.0.0, v1.0.1, v1.1.0 hay v2.0.0…? Không lẽ phải đau đầu khi phải nhìn lại một nùi commit?
  • Dễ dàng để tìm kiếm thuận tiện hơn thông qua regex.

Có lẽ các bạn cũng đã sử dụng một vài quy tắc đóng nào đó trong dự án của mình để giúp giải quyết một trong số vấn đề trên. Tại sao mình lại nói là quy tắc đóng? Đó là bởi vì nó mang tính cục bộ của riêng dự án của bạn mà thôi.

Vậy liệu đã có những quy tắc nào chung cho tất cả chúng ta?

  Tôi đã viết API Document cho dự án như thế nào?
  Giao dịch trong Bitcoin hoạt động như thế nào?

Conventional Commits

Conventional Commits là một bộ quy tắc viết commit message sinh ra mục đích để cả người và máy đều có thể đọc được. Máy ở đây có thể hiểu như là các tools phục vụ cho việc versioning một cách tự động chẳng hạn.

Bộ quy tắc này tương khớp với SemVer (Semantic Version) bởi cách nó mô tả các feature, fix bugs hay là refactor code.

Hiện tại, ở thời điểm viết bài này, bộ quy tắc Conventional Commits đang ở version 1.0.0-beta.4 và có thể có các bổ sung trong tương lai.

Git conventional commits được áp dụng rất nhiều trong repository. Đặc biệt là những project open source khi có sự đóng góp của hàng nghìn contributors.

Bạn có thể tham khảo việc thực hiện conventional commits trong một số project open trên github. Điển hình như là repository to của Electron tại đây hay ngay trên cả repository của Viblo như viblo-asia/survey-results.

Cấu trúc commit message

Cấu trúc chung của một commit message theo conventional có dạng:

Trong đó:

  • Các thành phần typedescription 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: từ khóa để phân loại commit là feature, fix bug, refactor… Chú ý ngay sau type có dấu : nữa nhé.
  • scope: cùng được dùng để phân loại commit, nhưng trả lời câu hỏi: “commit này refactor|fix cái gì?”. Được đặt trong cặp ngoặc đơn ngay sau type. VD: feat(authentication):fix(parser):.
  • description: là mô tả ngắn về những gì sẽ bị sửa đổi trong commit đấy.
  • body: là mô tả dài và chi tiết hơn, cần thiết khi description chưa thể nói rõ hết được.
  • footer: một số thông tin mở rộng như số ID của pull request, issue.. được quy định theo conventional.

Như vậy, mình có thể lấy một số ví dụ cho một commit message ngắn như sau:

Semantic Versioning

Conventional Commit tương khớp với SemVer thông qua type trong commit message.

Các tool automate versioning cũng dựa vào nó để quyết định version mới cho source code.

Với quy ước như sau:

  • fix: một commit thuộc loại fix bug sẽ thay đổi PATCH trong version (theo semantic version).
  • feat: một commit thuộc loại thêm feature sẽ thay đổi MINOR trong version theo (semantic version).
  • Ngoài ra, từ khóa BREAKING CHANGE trong phần body của commit message sẽ ám chỉ là commit này có phần sửa đổi khiến code sẽ không còn tương thích với version trước đó. Như việc thay đổi cấu trúc response của một API, tất nhiên phần handle response theo cấu trúc trước đó sẽ không còn chính xác và lúc này chúng ta cần tạo một version mới hoàn toàn với việc thay đổi MAJOR trong version.

Xem thêm API là gì.

Một số type phổ biến

Một số type phổ biến được khuyên sử dụng bao gồm:

  • feat: thêm một feature.
  • fix: fix bug cho hệ thống.
  • refactor: sửa code nhưng không fix bug cũng không thêm feature hoặc đôi khi cũng bug cũng được fix từ việc refactor.
  • chore: một số thay đổi lặt vặt.
  • docs: thêm/thay đổi document.
  • style: những thay đổi không làm thay đổi ý nghĩa của code như thay đổi css/ui chẳng hạn.
  • perf: code cải tiến về mặt hiệu năng xử lý.
  • vendor: cập nhật version cho các dependencies, packages.

Ngoài feat, fix mà bắt buộc để tuân thủ Semantic Versioning thì chúng ta vẫn có thể sử dụng type là các danh từ mà chúng ta tự định nghĩa nhé.

Tóm tắt các quy tắc

Các quy tắc cũng khá đơn giản và dễ nhớ. Khi viết commit theo cấu trúc bên trên là chúng ta đã tuân thủ gần hết bộ quy tắc này rồi, điểm qua bao gồm:

  • Commit message phải có prefix là một type (dạng danh từ) như featfix.. Theo ngay sau là scoped (nếu có) và một dấu hai chấm và khoảng trắng như chúng ta vừa đề cập ở trên. VD: feat:fix:.
  • feat type này thì bắt buộc phải sử dụng khi thêm một feature.
  • fix type này bắt buộc phải sử dụng khi fix bug.
  • Nếu có scope, scope phải là một danh từ mô tả về vùng code thay đổi và phải đặt ngay sau type. VD: feat(authentication).
  • Một description phải là mô tả ngắn về các thay đổi trong commit và phải ở sau một khoảng trắng sau type/scope.
  • Một commit dài thì có thể có phần body ngay sau description, cung cấp ngữ cảnh về các thay đổi. Phải có một dòng trắng giữa description và body.
  • Phần footer có thể được đặt ngay sau body, phải có một dòng trắng giữa body và footer. Footer phải chứ các thông tin mở rộng về commit như các pull request liên quan, các người review, breaking changes. Mỗi thông tin trên một dòng.
  • Các type khác feat và fix có thể được sử dụng trong commit message.

Nhìn chung mấy cái bên trên này chúng ta không phải nhớ nhiều vì khi viết commit theo cấu trúc ở phần một là nó đã đúng hết luôn rồi.

Ngoài ra còn một vài quy tắc khác như:

  • Commit breaking changes thì phải chỉ rõ ngay khi bắt đầu body hoặc footer với từ khóa BREAKING CHANGE viết hoa. Theo sau là dấu hai chấm và một khoảng trắng.

VD:

  • Một description nữa phải được cung cấp ngay sau BREAKING CHANGE, mô tả những thay đổi của API.

VD:

  • Một dấu chấm than ! có thể thêm vào trước dấu : trong type/scope để gây chú ý và nhấn mạnh rằng commit này là breaking change.

Tổng kết lại

Như trong bài viết đã trình bày, các quy tắc trong Conventional Commits quả thật là rất đơn giản và dễ áp dụng phải không nào? Nhớ lại ngày xưa, khi release mình hay dùng lệnh git logs để lấy ra commit message làm CHANGE LOGS.

Và bây giờ, sau khi dự án áp dụng Conventional Commits thì rõ ràng chúng ta có thể:

  • Sử dụng Semantic Release để automate versioning. Tự động tạo CHANGE LOGScho dự án với plugins của semantic-release.
  • Sử dụng Commit Lint để check commit message theo Conventional Commits.
  • Việc tìm kiếm lại commit history cũng đơn giản hơn khi có thể sử dụng regex để lọc commit qua type/scope.

Trên đây là chia sẻ về cách để viết commit message như thế nào cho chuyên nghiệp và hiệu quả nhất.

Cảm ơn các bạn đã đọc bài viết của mình!

Có thể bạn quan tâm:

Xem thêm việc làm Software Developers trên TopDev

TopDev via viblo.asia

  Những lập trình viên phiên bản X-men: Những code project "dị" nhất trên GitHub
  43 kho lưu trữ Github JS phổ biến nhất 2019 -  Bạn đã biết hết chưa?
SHARE