Nếu tôi bắt gặp một lỗi đánh máy không quan trọng trong mã (giả sử, dấu nháy đơn sai lầm trong câu lệnh in (lỗi), có đáng để thực hiện một cam kết để khắc phục lỗi đó không, hay đơn giản là nên để yên?

Cụ thể, tôi tò mò về việc cân nhắc việc ghi nhật ký cam kết với giá trị của việc giải quyết các lỗi chính tả không quan trọng này. Tôi đang nghiêng về việc giải quyết chúng. Tôi có phải là người phạm tội không?

Cảm nhận cá nhân của tôi là việc cải thiện chất lượng đáng giá với sự bất tiện nhỏ của một mục nhật ký cam kết bổ sung, ngay cả đối với những cải tiến nhỏ. Rốt cuộc, những cải tiến nhỏ tính rất nhiều khi bạn tính đến hiệu ứng cửa sổ bị hỏng .

Bạn có thể muốn tiền tố nó bằng một TRIVIAL:thẻ hoặc đánh dấu nó là tầm thường nếu VCS của bạn hỗ trợ nó.

Bạn không phải là người phạm tội, và tốt hơn là giải quyết chúng riêng lẻ. Thay đổi càng nhiều nguyên tử thì càng tốt - bạn không muốn sửa lỗi bị lỗi được trộn lẫn với 500 thay đổi nhận xét / lỗi đánh máy.

Trong trường hợp chung: Có

Nó luôn luôn xứng đáng để tăng khả năng bảo trì phần mềm của bạn.

Chỉ cần đi cho nó.

Nếu bạn chuẩn bị phát hành ...

... Và nếu bạn không phải là trưởng nhóm, thì hãy kiểm tra với anh ấy / cô ấy .

Về nội dung của nhật ký cam kết ...

Tôi đồng ý với những người khác rằng ít nhất bạn nên viết một cái gì đó làm cho nó khác biệt với các cam kết liên quan đến "tính năng", nếu đó chỉ là về việc sửa một lỗi đánh máy bị cô lập.

Một thực tế phổ biến là có một số nhiệm vụ không bao giờ chết trong trình theo dõi vấn đề của bạn để theo dõi những thay đổi vượt thời gian và vô tận. Chẳng hạn, không có gì lạ khi có một nhiệm vụ cho:

• dọn dẹp tự động vô hại lớn (quét lòng trắng),
• ngữ pháp và lỗi đánh máy,
• xây dựng sửa đổi hệ thống,
• Vân vân...

Chỉ cần thận trọng rằng những thứ này không được sử dụng làm ID nhiệm vụ vứt đi cho bất cứ thứ gì khi mọi người lười biếng trong việc tạo vé tài liệu chính xác. Đặc biệt nếu bạn từ chối các cam kết không được liên kết với ID (đó là một điều tốt, nhưng các tác vụ lớn như thế này sẽ còn hấp dẫn hơn đối với các nhà phát triển lười biếng).

Typose nên được thêm vào như một cam kết. Sửa các từ sai chính tả hoặc lỗi ngữ pháp sẽ làm tăng khả năng đọc mã của bạn.

Sử dụng một thông điệp cam kết như "Đã sửa lỗi chính tả" hoặc "Đã sửa lỗi chính tả trong file.c" sẽ giúp bạn phân biệt các cam kết này với các cam kết mã chính khác.

Có, bạn hoàn toàn nên làm điều này, đặc biệt là sớm trong một dự án.

Tại sao? Hai điểm:

1. Bạn có thể sẽ không biết liệu một lỗi đánh máy có "nghiêm trọng" hay không cho đến khi quá muộn. Một số bản sửa lỗi có thể không được sửa vì mọi người nghĩ rằng nó sẽ không phải là vấn đề lớn. Đến khi nó.

2. Sửa lỗi chính tả sớm và cố tình sẽ dễ dàng hơn nhiều so với sửa lỗi sau hàng trăm dòng lệnh / hàm đã được thực hiện với nó. Một lần nữa, hack tạm thời có thể trở thành bán vĩnh viễn một cách đáng ngạc nhiên nhanh chóng. Đây là lý do tại sao tôi phải xử lý các đối tượng có cả hai phương thức "Thu gọn" và "Colapse ALL".

Đối với các lỗi ngữ pháp mà người dùng cuối có thể nhìn thấy, thì có, bằng mọi cách, nó đáng để thực hiện cam kết vì hoàn toàn có thể người dùng hoặc QA có thể đi cùng và báo cáo lỗi và cần phải theo dõi. Nếu nó đã được sửa thì nó có thể giải quyết nhanh thời gian cần thiết để giải quyết vấn đề.

Nếu đó là một lỗi ngữ pháp trong các nhận xét xung quanh mã, tôi sẽ không làm gì về nó trừ khi đó là một phần của các thay đổi đối với mã thực tế cũng như trong trường hợp bạn đang cập nhật tài liệu về mã.

Nếu bạn lo lắng về việc ghi lại nhật ký cam kết, thì bạn đã làm sai điều gì đó. :-) Cam kết thường xuyên là một điều tốt! Tôi cam kết sửa lỗi chính tả mọi lúc. Nhận chúng trong codebase càng sớm càng tốt và tăng tốc chu kỳ dev!

Tôi bỏ phiếu đồng ý. Hãy kiểm tra chúng. Tôi đã làm việc cho một công ty ghét mọi người kiểm tra nội dung. Ý tôi là hầu hết mọi thứ. Các đánh giá mã được mở rộng và vì vậy nếu bạn kiểm tra một thay đổi chỉ sửa lỗi chính tả bạn đã rên rỉ. Bạn có thể tưởng tượng trạng thái của mã. Trên thực tế, mã không đáng sợ, nhưng nó chảy ra như nước giải khát chứ không chảy như rượu.

Có quy trình quản lý thay đổi của bạn cho phép nó?

Trong môi trường của tôi, mọi cam kết tôi thực hiện phải được gắn lại với yêu cầu thay đổi đã được yêu cầu bởi người dùng doanh nghiệp hoặc thay đổi cấp độ hệ thống bắt buộc, hoàn thành với các quy trình thử nghiệm của người dùng cuối tương ứng. Một lỗi đánh máy đơn giản như bạn mô tả có thể sẽ không được ghi lại như một trong những lỗi đó (Tôi đã tìm thấy lỗi chính tả và lỗi ngữ pháp trong một trong những ứng dụng của tôi tồn tại hơn 4 năm mà không ai nhận ra), vì vậy, nếu / khi kiểm toán viên đến gọi tôi sẽ có một thời gian rất khó giải thích bản thân mình.

Tôi sẽ lưu một thay đổi như bạn đang mô tả (và thực tế là có một thay đổi, như một vấn đề thực tế - một tên phương thức bị đánh vần sai và tôi chỉ phát hiện ra nó) trong một thời gian khi tôi có một thay đổi "thực sự" cần phải có cũng được thực hiện và đặt "lỗi chính tả khác nhau" trong nhật ký.

Sử dụng DVCS để chỉnh sửa lịch sử

Nếu bạn lo ngại về lịch sử cam kết sạch sẽ, hãy xem xét thực hiện công việc chính của bạn trong các nhánh tính năng . Nếu bạn tình cờ làm việc với một VCS phân tán , bạn có thể dễ dàng chỉnh sửa lịch sử cam kết của mình trước khi đẩy nó sang nhánh chính. Nếu bạn đang ở trên SVN, hãy thử Git - nó có thể tương tác hai chiều với Subversion và bạn cũng có thể chỉnh sửa lịch sử trước khi thực sự cam kết Subversion.

Giữ ý thức chung

Nếu bạn không muốn hoặc không thể chỉnh sửa lịch sử cam kết, không có lý do chức năng nào để thực hiện cam kết sớm hoặc nguyên tử cho một lỗi đánh máy nhỏ không ảnh hưởng đến kiểm tra hoặc biên dịch tự động . Trong trường hợp này, theo tôi, giữ cho lịch sử cam kết sạch sẽ quan trọng hơn việc thực hiện các cam kết nguyên tử. Trộn một hoặc hai sửa lỗi chính tả với sửa đổi "thông thường" sẽ không gây hại cho bất kỳ quy trình đánh giá tiềm năng nào. Tuy nhiên, bạn có thể muốn nhóm một số sửa chữa nhỏ vào một cam kết, có lẽ khi "dọn dẹp" sau một phiên mã hóa lớn hơn.

Lưu ý rằng các lỗi chức năng vẫn phải được cam kết càng sớm càng tốt trong một cam kết nguyên tử.

Giọng điệu chung của các câu trả lời ở đây dường như gợi ý một chiến lược "cam kết mọi thứ nhanh chóng" ngay cả đối với các lỗi chính tả nhỏ. Tôi có xu hướng không đồng ý và hoan nghênh thảo luận.