riseproject-dev / riseproject-dev/python-wheels

docs: PRs should only specify the license, not extract from LICENSE files

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

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

documentation enhancement good first issue infrastructure
Ngôn ngữ chính
Python
Star
0
Fork
0
Merge trung bình
16 giờ 14 phút
Pull request đã merge (30 ngày)
952

Mô tả

Some upstream projects point at a license file with the license field in pyproject.toml. This causes our auto docs updates to pull in the entire license file's contents. This has not been a big issue since it isn't common, but it should be fixed so that the workflows/scripts only identify the correct license type and indicate it in the package's doc.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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 bằng cách xác định workflow hoặc script chịu trách nhiệm cập nhật tài liệu tự động và kiểm tra cách nó đọc trường license từ pyproject.toml. Xác minh thay đổi bằng một package có trường license trỏ đến tệp LICENSE; được xem là hoàn tất khi tài liệu của package xác định loại license mà không bao gồm toàn bộ nội dung tệp.

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, tooling
Loại issue
Lỗi
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Sôi nổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
65/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.