cncf / clomonitor

CLOMonitor is a tool that periodically checks open source projects repositories to verify they meet certain project health best practices
https://clomonitor.io
Apache License 2.0
106 stars 66 forks source link

Add check for "TRADEMARKS" #33

Open caniszczyk opened 2 years ago

caniszczyk commented 2 years ago

CNCF Projects have to xfer their trademark over to the foundation.

There's no easy way to check for this but @amye were chatting that we may have a new policy in CNCF to have a "TRADEMARKS" file at the root of the repo that essentially links to https://www.linuxfoundation.org/trademark-usage/ after we confirm the paperwork is sent our way

matthewpereira commented 1 year ago

Hey folks, it looks like clomonitor currently looks for a trademark statement with the following regex:

"https://(?:w{3}\.)?linuxfoundation.org/trademark-usage"

However, the Linux Foundation's website has a different URL (maybe they updated it): https://www.linuxfoundation.org/legal/trademark-usage

Currently, https://www.linuxfoundation.org/trademark-usage redirects to https://www.linuxfoundation.org/legal/trademark-usage , but relying on that forever seems like a potential pitfall. This also presents some friction to people that might copy the URL from the real trademark usage page, and then find they're still failing the clomonitor check.

It seems like it might be a good idea to change the regex to the following:

"https://(?:w{3}\.)?linuxfoundation.org/legal/trademark-usage"

Or, if you want to allow for some backward compatibility,

"https://(?:w{3}\.)?linuxfoundation.org/(?:legal/)?trademark-usage"

I'm happy to make a PR, let me know if you prefer one option or the other, or if this is already being handled elsewhere.

tegioz commented 1 year ago

Hi @matthewpereira 👋

A PR sounds great, thanks! I think it's better if we keep the backwards compatible option for now.