[rl-assigned_teams-5] Violation against OSS Rules of Play

sap-ospo-bot commented 3 years ago

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-assigned_teams-5 Explanation: Does teams have enough members on GitHub? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

spier commented 3 years ago

Hah, what happened here? Looks like the SAP bot found this project? :)

This looks interesting.

For the uninitiated (like me) these issues might be a bit cryptic. e.g. I couldn't find out how many members the project needs in order for this check to pass, and the rule ID above didn't match anything in the docs either.

However I suspect these checks are mostly meant for the admins of this repo anyways?

SebastianWolf-SAP commented 3 years ago

Well, it's not really hard to find it as it's in the SAP organization... ;)

We (SAP Open Source Program Office) only enabled an automated check for all our open source projects if they match our guidelines. In general, we ask the projects to have an admin and a "normal" members team. To ensure proper maintenance in the long run, both teams should have at least two members, so that there is a chance that there is a substitute if the other person is not there.

For that particular rule, the documentation is also listed on the referenced page:

Whether the project’s members team has at least two members or not.

spier commented 3 years ago

Thanks for the pointer, now I see which rule was used.

Again, if the GitHub issue is mostly meant for people from the SAP OSPO and for Admins/Members of this repo, then you can disregard my comments. In this case I would only suggest to make that more clear in the issue.

However if one would want to make these issues easier to understand for contributors (like myself), then here a couple of ideas how that could be achieved:

more info in the title: e.g. [OSS Rules of Play] Members Team is too small - Also sounds a bit more friendly than "Violation" :)
more info about the rule itself into the description e.g. The Members Team needs to have at least two members.
direct link to further information where applicable e.g. if the issue had a direct link to rule 12 (the one you quoted), it would be easier to find.
no internals that people from outside of SAP cannot look up e.g. the reference rl-assigned_teams-5 does not help in finding out which rule was checked here.

If you think this feedback would be useful, I am also happy to post it on https://github.com/SAP/fosstars-rating-core/issues, if that is the more appropriate feedback channel?

Cheers

SebastianWolf-SAP commented 3 years ago

Well, feedback like that is always valuable - no matter if it comes from maintainers or contributors. In the end the OSS rules of play rating should also be in a shape that it can be used by others. There is a reason why we are using Fosstars and contributed the checks to the open source project. ;)

We will most certainly also bring up a small explanation page that brings together the customized IDs with the individual rule descriptions. There is nothing to be kept secret - it's simply that it doesn't fit in the generic documentation as it's specific to the check run and it was simply more important to bring the checks out as soon as possible.

Feel free to open issues on fosstars-rating-core for the improvement suggestions. We will address them! Thanks again!

Michadelic commented 3 years ago

updated the team as requested

SAP / project-portal-for-innersource

[rl-assigned_teams-5] Violation against OSS Rules of Play #27