2010-05-10 32 views
5

Tôi gặp khó khăn khi đặt câu hỏi đó nhưng ở đây. Tôi đang sử dụng kiểm soát nguồn từ vài năm cho nhiều dự án sử dụng các hệ thống khác nhau (svn, hg, git) và tôi đã học cách cải thiện thư của mình bằng cách thực hiện theo các hướng dẫn sau. Nhưng theo như tôi có thể nhớ mình chưa bao giờ có sau đó.Việc sử dụng thư cam kết là gì?

Vì vậy, ... làm thế nào để bạn thu lợi từ các thư cam kết của riêng bạn? Khi tôi cần quay trở lại vì tôi đã đập vỡ thứ gì đó và cần một khởi đầu mới mẻ, tôi thường chỉ quay lại "nút" mới nhất (nơi tôi bắt đầu hoặc sáp nhập một chi nhánh). Tôi có viết những thông điệp này chỉ cho những người theo dõi dự án đang tò mò về những gì đang diễn ra không?

Trân

Trả lời

6

"Gửi cho tôi một danh sách những điều bạn đã làm trong hai tuần qua" - Boss

+0

Tôi sẽ phải nói chuyện với sếp của mình về sự tin tưởng và cách thức các lập trình viên làm việc. Hoặc để lại;) – ericteubert

+3

Điều này có thể không liên quan gì đến sự tin tưởng. Cụ thể trong một trường hợp có ý nghĩ, anh chỉ muốn biết những gì cần đưa vào tài liệu ghi chú phát hành. – shoosh

+0

điểm tốt shoosh – ericteubert

3

Một điều tôi đã tìm thấy là những thông điệp cam kết là một cách tốt để giữ cho bản thân mình từ không cam kết thường xuyên. Nếu tôi không thể đặt các thay đổi thành một thông điệp cam kết ngắn, tôi có lẽ nên đã cam kết những thay đổi trước đó.

4

Thư của bạn dành cho người dùng khác nhiều hơn chính bạn. Mặc dù tôi đảm bảo đặt thông điệp cam kết tốt ngay cả trên repos cá nhân. Giúp đỡ khi bạn nhận được sidetracked trên một dự án và truy cập nó tháng xuống dòng để có được một xử lý của các công việc gần đây thực hiện trên một dự án.

+2

Không có gì tôi ghét hơn là cập nhật và nhận được hàng chục tệp được cập nhật và không có thông báo cho tôi biết lý do những tệp đó phải được thay đổi. – tster

+0

Đồng ý. Tôi thấy mã cam kết với một thư viện chung không có đầu mối về lý do tại sao chúng được tạo ra - tôi thích điều đó;) –

7

Bạn viết chúng như một trợ giúp cho bản thân tương lai của bạn và những người khác trong nhóm. Để cung cấp cho bạn một số thông tin cơ bản khi tôi thấy chúng hữu ích:

Tôi đã từng làm việc trên một dự án mà thư cam kết là vô giá - trong nhiều lần tôi sử dụng chúng để theo dõi mã đã cũ. Trong dự án đó, hệ thống theo dõi lỗi của chúng tôi cũng được tích hợp với VCS (ClearCase) của chúng tôi. Vì vậy, khi bạn đã kiểm tra thay đổi, nó sẽ ghi lại số lỗi trong các nhận xét cam kết. Điều này rất hữu ích để cho phép bạn theo dõi chính xác những gì đã thay đổi và tại sao.

Vì vậy, để tổng hợp, mặc dù thư cam kết có vẻ vô nghĩa nếu bạn mới bắt đầu (đặc biệt nếu bạn là người duy nhất làm việc trong dự án), chúng trở nên vô giá khi bạn có sản phẩm thành công được hỗ trợ trong sản xuất bởi nhiều nhà phát triển.

Cập nhật

Một tính năng hữu ích của bài viết cam kết là họ yêu cầu bạn phải xem xét và tóm tắt các thay đổi mà bạn vừa thực hiện. Ngay cả khi tôi nhớ những gì tôi đã thay đổi, tôi thường sẽ làm một cách nhanh chóng của một tập tin trước khi kiểm tra nó. Tôi sẽ đọc nó một lần nữa để đảm bảo không có typo, rằng tôi đã thay đổi mọi thứ tôi muốn, v.v. Đây là một cách đơn giản để xem xét mã của bạn cho những lỗi nhỏ nhỏ mà nếu không sẽ tìm thấy cách của họ vào mã của bạn. Dù sao, sau khi làm điều này tôi có một bức tranh rõ ràng về những gì đã thay đổi, vì vậy tôi sử dụng điều này để viết một bản tóm tắt ngắn gọn về sự thay đổi khi kiểm tra trong tập tin. Đây là một thói quen đơn giản giúp tăng chất lượng mã với ít nỗ lực từ phía bạn.

1

Trong trường hợp tốt nhất, cam kết được gắn với mục công việc trong trình theo dõi tính năng/lỗi. Bằng cách đó bạn sẽ có thể dễ dàng thấy tính năng/lỗi nào đã được triển khai/cố định. Điều này không chỉ hữu ích nếu biết một bản sửa đổi nhất định có chứa một tính năng hoặc sửa lỗi mà còn dễ dàng tạo ra một ghi chú phát hành.

1

Điều gì sẽ là điểm của một cam kết không có ghi chú để cho bạn biết đó là gì? Nó giống như hỏi 'Tại sao sách có tựa đề ở hai bên?', Hoặc có lẽ 'Tại sao sách lại có chỉ mục và số trang?'. Dường như với tôi rằng một bản ghi kiểm soát nguồn không có mô tả cho mỗi thay đổi sẽ không hữu ích lắm.

lý do bạn có thể cần phải tham khảo các cam kết thông báo bao gồm

  • Một lỗi đã nổi lên và bạn muốn tìm khi mà một phần của mã đã được thay đổi cuối cùng
  • Bạn quyết định lùi lại một số thay đổi và nhu cầu để quyết định sửa đổi nào để hoàn nguyên về số

Đối với một trong các khả năng này, không có thông báo cam kết tốt, bạn sẽ phải xem xét các thay đổi cho mỗi lần commit cho đến khi bạn tìm thấy những gì bạn đang tìm kiếm trong mã.

Các vấn đề liên quan