Add more examples to the NEWS/What's New docs
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ả
I think having a concise list is good, but if we want to elaborate more and clarify we could also provide some examples. An example for this is "a new feature was included in Python 3.13 alpha 1, but got removed in 3.13 beta 2, before the final release of 3.13.".
If we add examples, we could follow the ✔️ good/❌ bad format and do one or two lists with examples like:
✅ the following examples need a NEWS entry: * a new function, method, class, module * a new HOWTO in the documentation * the removal of a deprecated feature * ... ❌ the following examples *don't* need a NEWS entry: * a new feature was included in Python 3.13 alpha 1, but got removed in 3.13 beta 2, > before the final release of 3.13 * a typo fix in the documentation or in a docstring * the addition of a new test method * the removal of a private and internal API * code refactoring of a module with no user-visible effects
Originally posted by @ezio-melotti in https://github.com/python/devguide/pull/1238#discussion_r1417763167
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
Tìm tài liệu NEWS/What's New được issue tham chiếu và xem lại hướng dẫn hiện tại về thời điểm thêm một mục NEWS. Thêm các ví dụ ngắn gọn về trường hợp nên làm và không nên làm, bao gồm các trường hợp được liệt kê về bản phát hành Python, tài liệu, kiểm thử, private API và refactoring. Xác minh rằng các ví dụ hiển thị rõ ràng và phù hợp với hướng dẫn xung quanh.
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
- 52/100