Điều kiện tiên quyết
- Review đã kết nối với ít nhất một repository và đã có vài PR hoặc MR được merge. Xem Thiết lập Review.
- Bất kỳ vai trò workspace nào (Admin, Developer hoặc Viewer) để xem Insights. Muốn đổi lịch báo cáo, bạn cần vai trò Admin của workspace. Xem vai trò.
- Với tab Review Patterns: chế độ review phải là Advanced hoặc Auto, vì tab này chỉ tính Advanced Review. Với Auto, chỉ những thay đổi mà Auto chuyển sang Advanced Review mới được tính. Xem chế độ review.
Mọi người có vai trò trong workspace, kể cả Viewer, đều thấy bảng xếp hạng kèm tên developer, và không có tùy chọn nào để ẩn bảng này. Hãy trao đổi với nhóm trước khi triển khai Review.
Mở Insights
1
Vào Insights
Nhấn Review ở thanh điều hướng bên trái, rồi chọn Insights. Tiêu đề trang hiển thị Quality trends, patterns and contributions.
2
Chọn khoảng thời gian
Mở menu Date range ở góc trên bên phải. Các khoảng thời gian chia thành hai nhóm:
Tuần bắt đầu vào thứ Hai lúc 00:00 UTC. This Week không có xu hướng, nên tab Details và Review Patterns bị ẩn. Chọn khoảng dài hơn để hiện lại hai tab này.Khoảng thời gian là bộ lọc duy nhất. Insights luôn bao gồm mọi repository trong workspace. Để xem riêng một repository, hãy dùng các file PDF của repository đó trong tab Reports.
3
Chọn tab
Trạng thái thành công: các thẻ tóm tắt hiện ở đầu Leaderboard và Details, và tab bạn chọn hiển thị dữ liệu cho khoảng thời gian đó.
Thẻ tóm tắt
Leaderboard và Details mở đầu bằng bốn thẻ cho khoảng thời gian đã chọn:
Dải bên dưới các thẻ bổ sung tối đa ba tín hiệu, mỗi tín hiệu chỉ hiện khi có dữ liệu:
Không có lượt bình chọn nào trong khoảng thời gian thì tín hiệu accurate findings không hiện, thay vì hiển thị 0%. Nếu muốn có con số này, hãy nhờ nhóm bình chọn cho các phát hiện.
Leaderboard
Developer Leaderboard xếp hạng developer “by contribution and quality, as scored at merge”. Điểm được chốt khi thay đổi merge, nên việc sửa phát hiện về sau không làm thay đổi thứ hạng cũ.
Tác giả là bot bị loại khỏi mọi số liệu của Insights. Review nhận diện bot qua tên người dùng: hậu tố
[bot] của GitHub, đuôi -bot, _bot hoặc .bot, hoặc người dùng access token của project hay group trên GitLab. Service account mang tên khác vẫn được tính, và bạn không thể loại trừ tài khoản khỏi workspace.
Cách tính điểm
Ví dụ, developer có Quality Score 8 trong nhóm có trung bình 7, và tổng Impact 300 so với mức trung bình 200 của nhóm, sẽ đạt (1,14 + 1,50) ÷ 2 = 1,32.
Hãy dùng bảng xếp hạng để nhận ra ai cần hỗ trợ và cần hướng dẫn điều gì, đừng dùng làm thước đo hiệu suất: Impact đo quy mô, không đo giá trị.
Details
Details vẽ biểu đồ một chỉ số theo từng developer trong khoảng thời gian, rồi liệt kê từng tuần hoặc từng tháng trong một bảng.- Chọn chỉ số từ menu Metric: Contribution Score, Quality Score, Changes hoặc Total Impact.
- Đọc biểu đồ có tiêu đề tương ứng, ví dụ Quality Score by Developer.
- Cuộn xuống bảng để xem tổng của nhóm theo tuần hoặc tháng: Merge Requests hoặc Pull Requests, Team Quality, Total Impact, Findings và Authors.
Review Patterns
Review Patterns là chế độ xem dành cho việc hướng dẫn. Với mỗi developer, tab cho thấy các thay đổi đã review của họ được merge mà không có phát hiện nào trong từng lĩnh vực với tần suất bao nhiêu. Có bốn lĩnh vực:Những gì được tính
Chỉ các Advanced Review đã hoàn tất, không phải bản nháp, trên những thay đổi có kết quả được ghi nhận mới được tính. Fast Review, review chưa hoàn tất, phát hiện từ pipeline và tác giả là bot đều bị loại. Nếu không có gì đủ điều kiện, tab hiển thị No confirmed Advanced Reviews in this period. Tỷ lệ của một lĩnh vực là:Ưu tiên hướng dẫn chính
Đầu tab nêu tên lĩnh vực có tỷ lệ thay đổi bị ảnh hưởng cao nhất trên toàn nhóm. Khi hòa chính xác, số phát hiện Critical và High sẽ phân định. Nếu vẫn hòa, mọi lĩnh vực đồng hạng đều được liệt kê.Xem bằng chứng
1
Chọn một ô
Nhấn vào ô của một developer trong cột lĩnh vực.
2
Đọc xu hướng
Biểu đồ Weekly trend hoặc Monthly trend đặt developer đó cạnh đường Team của cả nhóm.
3
Mở các phát hiện
Bảng bằng chứng liệt kê từng phát hiện với Severity, Finding, Location, Review và Status (Open hoặc Resolved). Nhấn Load more evidence để xem các phát hiện cũ hơn, và theo liên kết Review để mở thay đổi.Trạng thái thành công: bạn chỉ ra được những phát hiện cụ thể phía sau một tỷ lệ trước khi trao đổi với developer.
Dữ liệu mỏng
Reports
Reports cung cấp cho mỗi repository hai file PDF mỗi tuần: Technical PDF cho kỹ sư và trưởng nhóm kỹ thuật, và Product PDF cho lãnh đạo sản phẩm và kỹ thuật. Các hàng được nhóm theo kỳ, mỗi repository một hàng gồm Repository, Generated, Trends, Actions, Status và PDFs. Bộ chọn khoảng thời gian bị ẩn trên tab này.1
Chọn cách chạy báo cáo
Bật Scheduled reports để tạo báo cáo vào mỗi thứ Hai từ 09:00 UTC (mỗi workspace bắt đầu trong vòng 30 phút sau mốc này). Nhấn Generate now để chạy ngay hôm nay. Muốn đổi lịch, bạn cần vai trò Admin của workspace.
2
Đọc báo cáo
Mở một hàng để xem bảng Repository report. Bảng hiển thị Trends, chẳng hạn “Findings down”, và Tracked actions: các hành động từ báo cáo này và các báo cáo trước, mỗi hành động được đánh dấu open, improved, resolved, regressed hoặc stale. Hàng cũng hiển thị tình trạng của repository: Healthy, Watch hoặc At risk, kèm điểm trên thang 10, hoặc Not rated yet.
3
Tải PDF
Tải Technical PDF hoặc Product PDF từ bảng chi tiết hoặc từ hàng. Hàng bị lỗi có nút Retry.
Khắc phục sự cố
Không thấy tab Details và Review Patterns
Không thấy tab Details và Review Patterns
Bạn đang chọn This Week, khoảng thời gian không có xu hướng. Chọn Last 4 Weeks hoặc dài hơn trong Date range.
Review Patterns hiển thị No confirmed Advanced Reviews in this period
Review Patterns hiển thị No confirmed Advanced Reviews in this period
Các thay đổi của bạn được review ở chế độ Fast, hoặc không review nào hoàn tất trong khoảng thời gian. Vào Review → Settings, trong mục General đặt Review mode thành Advanced hoặc Auto. Sau đó quay lại khi có thay đổi mới được merge. Các Fast Review trước đó sẽ không bao giờ xuất hiện ở đây.
Developer hiển thị Not enough data
Developer hiển thị Not enough data
Developer đó có ít hơn 3 thay đổi đã review trong khoảng thời gian. Hãy mở rộng khoảng thời gian, hoặc xem tỷ lệ Team.
Bảng xếp hạng trống hoặc thiếu người
Bảng xếp hạng trống hoặc thiếu người
Insights chỉ tính thay đổi đã merge. PR đang mở, PR bị đóng mà không merge và tác giả là bot đều không xuất hiện. Hãy kiểm tra PR đã được merge trong khoảng thời gian đã chọn.
Một bảng hiển thị Could not load
Một bảng hiển thị Could not load
Nhấn Retry trong bảng đó. Khoảng thời gian và tab bạn chọn vẫn được giữ nguyên.
Bước tiếp theo
Learnings
Biến lĩnh vực mà nhóm hay bỏ sót thành một rule mà mọi review đều áp dụng.
Review workspace
Mở các thay đổi phía sau một con số và xử lý dứt điểm các phát hiện.