Documenting minimizing diffs for ease of review
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 2.1k
- Fork
- 1k
- Merge trung bình
- 2 ngày 12 giờ
- Pull request đã merge (30 ngày)
- 12
Mô tả
Suppose we have some lines that are close to 80 chars long
first text ... end first text.
second text ... end second text.
third text ... end third text.
and if the first line needs some sort of modification that would push it past 80 chars, we can either restructure the entire paragraph of raw rst so it looks tidier, but resulting in 4 lines of git diffs
first text plus some more ...
end first text. second text ...
end second text. third text ...
end third text.
or diffs can be minimized (but with an 'uglier' raw rst), such as like
first text plus some more ...
... end first text.
second text ... end second text.
third text ... end third text.
I think that for ease of reviewing, as well as to maintain a more useful git history, that the second is preferred in general but I haven't found it in the style guide, so maybe it can be added there if there's consensus on it?
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Đọc style guide về tài liệu được liên kết trong issue và xem lại cuộc thảo luận hiện có về việc giảm thiểu diffs. Chỉ bổ sung hướng dẫn nếu dự án thống nhất về lựa chọn này, kèm các ví dụ cho thấy kiểu ngắt dòng được khuyến nghị; khi hoàn tất, style guide phải ghi rõ quy ước này.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100