Đánh giá mã

Question

Chỉ cần đặt trước nhận xét bằng nhãn, ý định rõ ràng và giọng điệu thay đổi đáng kể

Nội dung chính Show

Khán giả mục tiêu
Định dạng
đồ trang trí
Thêm ví dụ
Thực hành tốt nhất
Bạn muốn giúp làm cho điều này tốt hơn?
Nghệ thuật nguyên thủy
3 loại đánh giá mã hóa là gì?
Chọn nit là gì?
Một số phương pháp hay nhất để thực hiện đánh giá mã là gì?
7 bước để xem xét mã là gì?

gợi ý. Điều này không được diễn đạt chính xác

nitpick (không chặn). Điều này không được diễn đạt chính xác

Các nhãn cũng nhắc người đánh giá đưa ra nhiều nhận xét hữu ích hơn

gợi ý. Điều này không được diễn đạt chính xác

Chúng tôi có thể thay đổi điều này để phù hợp với từ ngữ của trang tiếp thị không?

Ghi nhãn các bình luận giúp tiết kiệm hàng giờ do thiếu thông tin và hiểu lầm. Chúng cũng có thể phân tích cú pháp bằng máy

ví dụ

gợi ý. Hãy tránh sử dụng chức năng cụ thể này…

Nếu chúng tôi tham khảo nhiều chức năng được đánh dấu là Không dùng nữa, thì gần như chắc chắn sẽ không đồng ý với chúng tôi, sớm hay muộn

vấn đề (ux, không chặn). Các nút này phải có màu đỏ, nhưng hãy xử lý vấn đề này trong phần tiếp theo

Khán giả mục tiêu

Nhận xét thông thường là một tiêu chuẩn để định dạng nhận xét của bất kỳ loại quy trình đánh giá/phản hồi nào, chẳng hạn như

Định dạng

Tuân thủ một định dạng nhất quán sẽ cải thiện kỳ vọng của người đọc và khả năng đọc của máy. Đây là định dạng chúng tôi đề xuất

 [decorations]: 

[discussion]

nhãn - Đây là một nhãn duy nhất cho biết loại nhận xét nào đang được để lại
chủ đề - Đây là thông điệp chính của bình luận
trang trí (tùy chọn) - Đây là các nhãn trang trí thêm cho nhận xét. Chúng được bao quanh bởi dấu ngoặc đơn và phân cách bằng dấu phẩy
thảo luận (tùy chọn) - Phần này chứa các câu hỗ trợ, ngữ cảnh, lý luận và bất kỳ điều gì khác để giúp truyền đạt “lý do” và “các bước tiếp theo” để giải quyết nhận xét

Ví dụ

câu hỏi (không chặn). Tại thời điểm này, chủ đề nào đã thắng có quan trọng không?

Có lẽ để ngăn chặn một điều kiện cuộc đua, chúng ta nên tiếp tục lặp lại cho đến khi tất cả họ đều thắng?

Có thể được tự động phân tích thành

{
  "label": "question",
  "subject": "At this point, does it matter which thread has won?",
  "decorations": ["non-blocking"],
  "discussion": "Maybe to prevent a race condition we should keep looping until they've all won?"
}

nhãn

Chúng tôi thực sự khuyên bạn nên sử dụng các nhãn sau

khen. Khen ngợi làm nổi bật một cái gì đó tích cực. Cố gắng để lại ít nhất một trong những nhận xét này cho mỗi bài đánh giá. Đừng để lại những lời khen ngợi sai lầm (điều này thực sự có thể gây tổn hại). Hãy tìm một cái gì đó để khen ngợi một cách chân thành. xoi mói. Nitpicks là những yêu cầu dựa trên sở thích tầm thường. Đây không phải là chặn bởi bản chất. gợi ý. Đề xuất đề xuất cải tiến cho chủ đề hiện tại. Điều quan trọng là phải rõ ràng về những gì đang được đề xuất và tại sao đó là một cải tiến. Cân nhắc sử dụng các bản vá và tính năng chặn hoặc không chặn để truyền đạt rõ hơn ý định của bạn. vấn đề. Các vấn đề làm nổi bật các vấn đề cụ thể với chủ đề đang được xem xét. Những vấn đề này có thể do người dùng gặp phải hoặc đằng sau hậu trường. Chúng tôi thực sự khuyên bạn nên ghép nhận xét này với một suggestion. Nếu bạn không chắc liệu có vấn đề nào tồn tại hay không, hãy cân nhắc để lại question. làm. TODO là những thay đổi nhỏ, tầm thường, nhưng cần thiết. Phân biệt nhận xét việc cần làm với các vấn đề. hoặc gợi ý. giúp hướng sự chú ý của người đọc đến các bình luận đòi hỏi sự tham gia nhiều hơn. câu hỏi. Các câu hỏi phù hợp nếu bạn có một mối lo ngại tiềm ẩn nhưng không chắc liệu nó có liên quan hay không. Yêu cầu tác giả làm rõ hoặc điều tra có thể dẫn đến một giải pháp nhanh chóng. tư tưởng. Suy nghĩ đại diện cho một ý tưởng nảy ra từ việc xem xét. Những nhận xét này về bản chất không bị chặn, nhưng chúng cực kỳ có giá trị và có thể dẫn đến các sáng kiến và cơ hội cố vấn tập trung hơn. việc vặt. Công việc nhà là những nhiệm vụ đơn giản phải được thực hiện trước khi đối tượng có thể được chấp nhận “chính thức”. Thông thường, những nhận xét này đề cập đến một số quy trình chung. Cố gắng để lại một liên kết đến mô tả quy trình để người đọc biết cách giải quyết công việc

Nếu bạn muốn biểu cảm hơn một chút với các nhãn của mình, bạn cũng có thể xem xét

đánh máy. Nhận xét đánh máy giống như việc cần làm. , trong đó vấn đề chính là lỗi chính tả. đánh bóng. Nhận xét tiếng Ba Lan giống như một gợi ý, trong đó không có gì sai với nội dung liên quan, chỉ có một số cách để cải thiện chất lượng ngay lập tức. không phân minh. Quibbles rất giống như nitpick. , ngoại trừ nó không gợi lên hình ảnh về chấy rận và thực hành vệ sinh động vật

Vui lòng chuyển hướng khỏi danh sách nhãn cụ thể này nếu nó có vẻ phù hợp

đồ trang trí

Đồ trang trí cung cấp ngữ cảnh bổ sung cho nhận xét. Chúng giúp phân loại thêm các nhận xét có cùng nhãn (ví dụ: đề xuất bảo mật trái ngược với đề xuất kiểm tra)

gợi ý (bảo mật). Tôi hơi lo ngại rằng chúng tôi đang triển khai chức năng thanh lọc DOM của riêng mình tại đây…

Thay vào đó, chúng tôi có thể cân nhắc sử dụng khung này không?

gợi ý (thử nghiệm, nếu nhỏ). Có vẻ như chúng tôi đang thiếu một số phạm vi kiểm tra đơn vị khiến con mèo biến mất hoàn toàn

Trang trí có thể cụ thể cho từng tổ chức. Nếu cần, chúng tôi khuyên bạn nên thiết lập một bộ đồ trang trí tối thiểu (để lại chỗ cho tùy ý) mà không có sự mơ hồ

Đồ trang trí có thể bao gồm

(không chặn)Nhận xét có trang trí này không được ngăn chủ đề đang được xem xét được chấp nhận. Điều này hữu ích cho các tổ chức coi việc chặn nhận xét theo mặc định. (chặn)Nhận xét có trang trí này sẽ khiến chủ đề đang được xem xét không được chấp nhận cho đến khi nó được giải quyết. Điều này hữu ích cho các tổ chức coi nhận xét không bị chặn theo mặc định. (if-minor)Trang trí này mang lại cho tác giả một số quyền tự do rằng họ chỉ nên giải quyết nhận xét nếu những thay đổi cuối cùng là nhỏ hoặc tầm thường

Thêm trang trí vào nhận xét sẽ cải thiện tính dễ hiểu và duy trì khả năng đọc. Có một danh sách nhiều đồ trang trí trong một bình luận sẽ mâu thuẫn với mục tiêu này

Thêm ví dụ

xoi mói. little star => little bat

Chúng tôi có thể cập nhật các tài liệu tham khảo khác không?

việc vặt. Hãy chạy công việc CI jabber-walk để đảm bảo rằng công việc này không phá vỡ bất kỳ tham chiếu đã biết nào

Dưới đây là các tài liệu để chạy công việc này. Vui lòng liên hệ nếu bạn cần bất kỳ sự trợ giúp nào

Thực hành tốt nhất

Chúng sẽ được mở rộng sau, nhưng hiện tại, đây là một số phương pháp hay nhất để viết phản hồi đánh giá hữu ích

Cố vấn trả hết theo cấp số nhân
Để lại nhận xét có thể hành động
Kết hợp các ý kiến tương tự
Thay thế “bạn” bằng “chúng tôi”
Thay “nên” bằng “có thể”

Bạn muốn giúp làm cho điều này tốt hơn?

Kiểm tra dự án GitLab cho trang web này. Các vấn đề và yêu cầu hợp nhất được hoan nghênh

Nghệ thuật nguyên thủy

Các nhân vật được sử dụng trong các ví dụ được chuyển thể một cách trân trọng từ Alice in Wonderland của Lewis Carroll, được minh họa bởi John Tenniel

3 loại đánh giá mã hóa là gì?

Thực hành đánh giá mã được chia thành ba loại chính. lập trình cặp, đánh giá mã chính thức và đánh giá mã nhẹ .

Chọn nit là gì?

/ˈnɪtˌpɪk. ɪŋ/ quá chú ý đến những chi tiết không quan trọng, đặc biệt là một cách chỉ trích . Nếu bạn dành ít thời gian soi mói hơn, bạn sẽ hoàn thành được nhiều việc hơn.