python / python/devguide

Clarify where docs fixes can be backported

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

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

needs: decision type-bug type-feature
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ả

The status key for branches has lists of changes that can go in, and the lists look exclusive:

feature:

  • new features, bugfixes, and security fixes are accepted.

prerelease:

  • feature fixes, bugfixes, and security fixes are accepted for the upcoming feature release.

bugfix:

  • bugfixes and security fixes are accepted, new binaries are still released. (Also called maintenance mode or stable release)

security:

  • only security fixes are accepted and no more binaries are released, but new source-only versions can be released

end-of-life:

  • release cycle is frozen; no further changes can be pushed to it.

This makes it a bit awkward to backport docs changes, especially now that the lists are included in the tag descriptions.

AFAIK, docs fixes don't need RM approval in feature, prerelease and bugfix branches. (Security branches are locked so any change needs the RM in the loop.)
Is that right, @pablogsal @Yhg1s ?

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.

Hướng nghiên cứu

Bắt đầu với khóa trạng thái được liên kết trong Python Developer’s Guide và so sánh mô tả các branch của nó với câu hỏi docs-backport được nêu. Xác nhận với các maintainer liên quan về các quy tắc phê duyệt đối với các bản sửa tài liệu trên các branch feature, prerelease, bugfix và security; được xem là hoàn tất khi trang này nêu rõ các thay đổi tài liệu có thể được backport đến đâu và có cần RM phê duyệt hay không.

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, release
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
35/100

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.