Post-migration Devguide reorganization
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 the Devguide is due for some reorganization after the migration.
In particular:
- The version control setup section should link to a separate "git" page (either the pullrequest or the committing page -- see below). (see #265)
- The compile and build section should be reorganized. (see #412)
- The lifecycle of a PR page seems to expand on the quick start, but doesn't include detailed setup instructions and git commands. This page seem to be aimed at contributors (see #265). Also the Generation section should be under Preparation, alongside another subsection about running tests.
- The runtests page expands on a paragraph pullrequest/preparation.
- The silence warnings and fixing easy issues are both 2-paragraphs pages that might be moved as sections of other pages.
- The tracker and triaging page should be updated and perhaps merged (see #308 and #339).
- The where to get help and following Python's development could be merged.
- The committing page seems to be aimed to core-dev, but since now the workflow for both core devs and contributors is quite similar, it should perhaps be merged with the pullrequest page. Parts of this page should be moved to other pages, and only the content relevant to core devs should be left there. (see #262 and #263)
- The continuous integration page should be updated. (see #290)
- The experts page should be moved closer to the developers page. (see #901)
- The mercurial for git developers page is now unnecessary, and it should either be removed, or better reversed and become "git for mercurial developers". (see #258)
- The adding to the stdlib page should first list what are good and bad addictions (with examples) and then explain the process to add something (see #35).
The other pages don't have any major issue :)
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
Xem lại các trang Devguide chưa được đánh dấu trong issue, đặc biệt là runtests, silence warnings, fixing easy issues, help and communication channels và adding to the stdlib. Trước tiên, hãy xác nhận những mục đã hoàn thành và các issues được tham chiếu nào vẫn phản ánh đúng site hiện tại, sau đó xác định những thay đổi vị trí trang và cập nhật nội dung còn lại. Được xem là hoàn tất khi một phương án tổ chức lại đã thống nhất được triển khai và các liên kết cùng điều hướng bị ảnh hưởng vẫn nhất quán.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- git, python
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- 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
- 25/100