Add pre-merge checklist in core developer guide

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#653 0 bình luận 1 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 2 ngày

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

Đánh giá

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

Hướng nghiên cứu

Chỉnh sửa phần đánh giá trong docs/developers/coredev/core_dev_guide.md được liên kết trong issue. Trước tiên, hãy đọc phần đó và điều chỉnh danh sách kiểm tra trước khi merge được đề xuất cho phù hợp với hướng dẫn hiện có; quyết định có mô tả bước kiểm tra cuối cùng và vai trò tự động hóa của bước này hay không. Công việc được xem là hoàn tất khi hướng dẫn đề cập đến các mục kiểm tra đã liệt kê và phân biệt giữa kiểm tra cuối cùng với thời gian chờ merge.

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

Mô tả

Our core developer guide has a section on reviewing, but it is missing essential information about merge-time conventions/etiquette. Especially now that @willingc is advocating for getting rid of the "ready to merge" wait period, I think it's important to add to the guide everything that needs to happen before a PR is merged:

  • check the type label type (feature, label, performance, etc)
  • check the milestone
  • check discussion comments are addressed or an issue is made to keep track of remaining to-dos
  • make sure the title still reflects the state/purpose of the PR
  • make sure the description reflects the current state/purpose of the PR (it's encouraged to leave the original description underneath under the heading "original description", since it provides the context for the subsequent discussion on the PR itself. However, the description becomes the commit message, so it should reflect the status of the PR at the time of merging.)

Some of those checks should ideally be automated, so we could perhaps rename "ready to merge" to "final checks" and keep it only for the automations, not for the wait period.

Ngôn ngữ chính
Makefile
Star
13
Fork
71
Merge trung bình
3 ngày 8 giờ
Pull request đã merge (30 ngày)
31

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có 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 napari/docs

Tất cả issue của napari/docs

Issue tương tự

Thêm issue về Documentation

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.