Improve the "Making Good PRs" section

Đang mở
#931 14 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách xác định phần "Making Good PRs" trong hướng dẫn dành cho nhà phát triển và xem xét hệ thống phân cấp tài liệu xung quanh. Quyết định phần này nên đề cập như thế nào đến tiêu đề và mô tả pull request chính xác, súc tích, cũng như liệu phần này có nên được đặt ở cấp cao hơn hay không. Được xem là hoàn tất khi hướng dẫn và vị trí của phần này phản ánh rõ ràng những cải tiến được issue đề xuất.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

good first issue type-bug type-feature

I often see PRs with misleading or vague titles. This is problematic, as the PR titles often end up being the commit titles, and commit titles are one of the most important tools we have when searching for historic changes. Bad titles impact maintainability.

Suggested edits:

  • Enforce a strict title format
  • Promote writing accurate and concise PR titles/descriptions

Perhaps the "Making Good PRs" section can be further promoted. Would it make sense to extract it and move it a level up in the doc hierarchy?

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của python/devguide

Tất cả issue của python/devguide

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.