Database
 sql >> Cơ Sở Dữ Liệu >  >> RDS >> Database

Quy ước đặt tên phân nhánh Git:Các phương pháp hay nhất

Git cung cấp các chiến lược phân nhánh linh hoạt, nhưng nó có nghĩa là gì? Nói một cách đơn giản, chiến lược phân nhánh là một tập hợp các quy tắc, một quy ước giúp các nhóm và nhà phát triển - họ có thể tuân theo các quy tắc và quy ước này để tạo một nhánh mới, quy trình của nó, v.v.

Không sử dụng các quy ước đặt tên thích hợp dẫn đến nhầm lẫn và làm phức tạp nhóm bảo trì mã. Chúng tôi không thể bỏ qua các phương pháp hay nhất của Git trong quy ước đặt tên phân nhánh.

Các chiến lược phân nhánh của Git cho phép phân tách công việc. Nhìn chung, chúng ta có thể chia các nhánh của Git thành hai loại:Các nhánh Thường xuyên &Tạm thời.

Các nhánh Git thông thường

Các nhánh này sẽ có sẵn trong kho lưu trữ của bạn trên các cơ sở vĩnh viễn. Quy ước đặt tên của họ rất đơn giản và dễ hiểu.

  • Phát triển ( dev ) là nhánh phát triển chính. Ý tưởng của nhánh nhà phát triển là thực hiện các thay đổi trong đó và hạn chế các nhà phát triển trực tiếp thực hiện bất kỳ thay đổi nào trong nhánh chính. Các thay đổi trong nhánh nhà phát triển sẽ được xem xét và sau khi kiểm tra, sẽ được hợp nhất với nhánh chính.
  • Master ( master ) là nhánh mặc định có sẵn trong kho lưu trữ Git. Nó phải ổn định mọi lúc và sẽ không cho phép bất kỳ đăng ký trực tiếp nào. Bạn chỉ có thể hợp nhất nó sau khi xem xét mã. Tất cả các thành viên trong nhóm có trách nhiệm giữ cho bản chính ổn định và cập nhật.
  • QA ( QA ), hoặc nhánh kiểm tra, chứa tất cả mã để kiểm tra QA và kiểm tra tự động hóa tất cả các thay đổi được triển khai. Trước khi có bất kỳ thay đổi nào đối với môi trường sản xuất, thay đổi đó phải trải qua quá trình kiểm tra QA để có được cơ sở mã ổn định.

Các nhánh Git tạm thời

Như tên gọi, đây là những nhánh có thể được tạo và xóa khi cần thiết. Chúng có thể như sau:

  • Sửa một số lỗi
  • Khắc phục sự cố
  • Các nhánh tính năng
  • Các nhánh thử nghiệm
  • Các nhánh WIP

Có nhiều định dạng và quy ước đặt tên được các chuyên gia khuyến nghị cho các nhánh tạm thời.

Đây là quy trình làm việc đơn giản của các nhánh Git.

Quy ước đặt tên phân nhánh Git

Trong bài viết này, tôi sẽ xem xét và chia sẻ bảy quy ước đặt tên tốt nhất mà cá nhân tôi đã sử dụng trong quá khứ để đảm bảo hiệu quả của chúng.

1. Bắt đầu tên chi nhánh bằng một từ Nhóm

Đó là một trong những cách thực hành tốt nhất. Từ nhóm có thể là bất cứ thứ gì để phù hợp với quy trình làm việc của bạn.

Tôi thích những từ ngắn gọn như sau:

Lỗi - Lỗi cần được sửa sớm

MẸO - Công việc đang được tiến hành và tôi biết rằng nó sẽ không hoàn thành sớm

Bằng cách nhìn vào tên nhánh, bạn có thể hiểu nhánh Git này nói về điều gì và mục đích của nó.

Hãy xem các ví dụ dưới đây:

  • bug-logo-alignment-problem - nhà phát triển đang cố gắng khắc phục sự cố căn chỉnh logo;
  • wip-ioc-container-added - nhánh liên quan đến nhiệm vụ thêm một IoC container đang được thực hiện.

2. Sử dụng ID duy nhất trong tên chi nhánh

Bạn có thể sử dụng Id trình theo dõi vấn đề trong tên chi nhánh của mình. Tôi thích phương pháp này hơn khi sửa một số lỗi. Ví dụ:

wip-8712-add-testing-module

Tên cho thấy nhánh áp dụng cho nhiệm vụ thêm mô-đun thử nghiệm, Id theo dõi của vấn đề là 8712 và công việc đang được tiến hành.

Một lợi thế nữa của việc sử dụng ID theo dõi bên ngoài trong tên chi nhánh là khả năng theo dõi tiến trình từ một hệ thống bên ngoài.

3. Sử dụng dấu gạch ngang hoặc dấu gạch chéo làm dấu phân cách

Nhiều nhà phát triển sử dụng dấu gạch chéo làm dấu phân cách và nhiều nhà phát triển sử dụng dấu gạch nối. Việc sử dụng cái nào - tùy thuộc vào sở thích của bạn và nhóm của bạn.

Ý kiến ​​của tôi là dấu gạch nối làm cho tên dễ đọc hơn, vì vậy nó là dấu phân tách phù hợp trong tên nhánh. Bạn có thể sử dụng dấu gạch chéo, dấu gạch nối và dấu gạch dưới. Vấn đề là phải nhất quán.

Có hai ưu điểm chính của việc sử dụng dấu phân tách trong tên chi nhánh:

  1. Nó làm tăng khả năng đọc và giúp tránh nhầm lẫn;
  2. Điều này giúp bạn dễ dàng quản lý hơn, đặc biệt nếu bạn đang giao dịch với nhiều chi nhánh.

Ví dụ 1. Tên nhánh Git không có dấu phân tách:

featureupgradejqueryversionloginmodule

Ví dụ 2. Bằng cách thêm dấu phân tách (trong trường hợp này là dấu gạch dưới), bạn làm cho tên nhánh Git có thể đọc được:

feature_upgrade_jquery_version_login_module

4. Nhánh Git với Tên tác giả

Nhiều công ty thích thêm tên tác giả vào tên chi nhánh theo định dạng bên dưới:

<author>_<branch-type>_<branch-name>

Ví dụ: rajeev.bera_feature_new-testing-changes

Phương pháp này cho phép dễ dàng theo dõi công việc và tiến độ của các nhà phát triển khác nhau bằng các hệ thống bổ sung.

5. Tránh chỉ sử dụng số

Một số nhà phát triển chỉ sử dụng Id vấn đề trong tên chi nhánh, điều này không hữu ích trong tiến độ công việc.

Ví dụ, có một tên nhánh 9912 - con số kỳ diệu này sẽ cho chúng ta biết điều gì? Nó chỉ có nghĩa là nhiều nhầm lẫn và nguy cơ mắc lỗi, đặc biệt là trong quá trình hợp nhất với các nhánh git khác.

6. Tránh sử dụng đồng thời tất cả các quy ước đặt tên

Trộn và so khớp tất cả các quy ước đặt tên nhánh của Git không phải là cách tốt nhất. Nó chỉ làm tăng thêm sự nhầm lẫn và làm phức tạp các quy trình tổng thể.

Một nhóm nên quyết định các quy ước đặt tên để sử dụng trong công việc một lần và tuân theo chúng. Nhất quán là điều quan trọng nhất.

7. Tránh các tên mô tả dài cho các nhánh sống lâu

Chất lượng cơ bản của tên chi nhánh là nó phải chính xác và đầy đủ thông tin. Hãy cùng xem lại một số ví dụ:

wip_login_module_which_will_used_in_the_public_website
wip_login_module_which_will_used_in_the_internal_website

Ở đó, tên các nhánh dài và chi tiết. Nó không phải là cần thiết. Thay vào đó, bạn có thể sử dụng biến thể sau:

wip_feature_login_module

Tên này tuy ngắn gọn nhưng nó giải thích mục đích của nhánh này.

Kết luận

Mô hình phân nhánh Git rất mạnh mẽ, nhưng bạn cần quản lý các nhánh một cách chính xác và hiệu quả. Một trong những yếu tố cần thiết là tuân theo các quy ước giống nhau của tất cả các nhóm, đặc biệt - quy ước đặt tên cho kho lưu trữ cục bộ.

Để đảm bảo nhóm của bạn đang sử dụng các quy ước đã thống nhất, hãy thực thi các tiêu chuẩn. Một trong những cách dễ nhất là sử dụng Git hook, như pre-commit hook. Tôi hy vọng nó sẽ cung cấp cho bạn ý tưởng về các mô hình phân nhánh Git và quy ước đặt tên của chúng.


  1. Database
  2.   
  3. Mysql
  4.   
  5. Oracle
  6.   
  7. Sqlserver
  8.   
  9. PostgreSQL
  10.   
  11. Access
  12.   
  13. SQLite
  14.   
  15. MariaDB
  1. Tác dụng phụ không mong muốn của việc thêm chỉ mục được lọc

  2. Sử dụng các phiên bản được đặt tên? Kiểm tra kết nối DAC của bạn!

  3. SCD loại 2

  4. Ngôn ngữ truy vấn có cấu trúc - Tầm quan trọng của việc học SQL

  5. Cơ sở dữ liệu chuỗi thời gian là gì?