aboutcode-org / aboutcode-org/scancode-toolkit

Best practices for homepage_url in rules

Đang mở
#4,748 1 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
Python
Star
2.6k
Fork
791
Merge trung bình
1 ngày 12 giờ
Pull request đã merge (30 ngày)
5

Mô tả

Currently the `homepage_url` attribute in scancode rules can point to an arbitrary URL, but typically is pointing to some Git URL. This Git URL often points to the `main` or `master` branch, which is a moving target, as it can change. I would suggest to instead require that `homepage_url` points to a specific commit to prevent things no longer being in sync.

An example:

https://scancode-licensedb.aboutcode.org/bear-blog-2.0.html

`homepage_url` points to https://github.com/HermanMartinus/bearblog/blob/master/LICENSE.md but could also have pointed to: https://github.com/HermanMartinus/bearblog/blob/998e87263248d21c8c5b967de0047b0cdf4dc11c/LICENSE.md

This URL, unless the commit is deleted, would never change, whereas the current one (pointing to `master`) actually *can* change. To remedy URLs being deleted I would recommend making a copy in the Internet Archive, or to use some sort of identifier from Software Heritage (and these are not mutually exclusive).

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

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

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.