Add a checklist of standard tasks to the PR template & CONTRIBUTING.md

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

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

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
82/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
swift
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách tìm mẫu PR hiện có và CONTRIBUTING.md, rồi đọc cả hai từ đầu đến cuối để xem giọng điệu và cách bố trí các phần hiện tại. Chuyển danh sách trong issue thành các mục checklist, liên kết Scripts/format.sh, swift test và các nguồn DocC dưới Sources/ArgumentParser/Documentation.docc ở đúng vị trí. Hoàn tất nghĩa là cả hai tệp đều có cùng checklist, với một người bảo trì có thể đánh dấu từng mục trong một PR.

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

Mô tả

documentation

A lot of PRs don't seem to have updated various subsystems or files that should also have been updated to correspond with the changes from the PR (see list below).

To avoid oversights, please add a checklist of standard tasks to the PR template & CONTRIBUTING.md (& wherever else is advisable), including subsystems / files that should be updated to correspond with included changes when necessary:

  • Input validation (if / when it is implemented)
  • Help output
  • ToolInfo (including which versions should be updated)
  • Completions
  • Formatting (via Scripts/format.sh)
  • Documentation (under Sources/ArgumentParser/Documentation.docc, maybe with a link to mappings from Swift directories or files to md files)
  • Documentation (DocC in Swift files)
  • Adding / updating tests (maybe with a link to tests that should be updated per Swift directory and/or file)
  • Testing (swift test)
  • Etc.
Ngôn ngữ chính
Swift
Star
3.8k
Fork
436
Merge trung bình
4 ngày 11 giờ
Pull request đã merge (30 ngày)
2

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

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 apple/swift-argument-parser

Tất cả issue của apple/swift-argument-parser

Issue tương tự

Thêm issue về Swift

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.