aboutcode-org / aboutcode-org/scancode-toolkit

Best practices for homepage_url in rules

未关闭
#4,748 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
2.6k
派生
791
平均合并
1 天 12 小时
30 天内合并 PR
5

描述

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).

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。