You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
So, the criteria used for determining badge levels is SUPER thorough, covering a variety of best practices. Awesome!
However. It's also HELLA intimidating if you are in the seat of an open source project trying to pass said criteria. :)
The goal of this issue would be to create some "how to" / tutorial documentation to explain to maintainers:
For any that are not self-explanatory, provide a longer-form description with links to more background info.
Provide some pointers to good examples that meet the criteria.
Similarly, provide some examples of what does NOT meet the criteria.
If this concept is totally new to a project, some "getting started" material on where to start in creating/starting such documentation/process in your project.
(ideally) A pointer to some sort of designated forum / Slack channel / etc. for maintainers to ask Q&A as they go through
(probably other things)
If this is seen as a worthy idea, I'd be happy to chip away at it over time.
The text was updated successfully, but these errors were encountered:
We certainly want it to be as easy as possible to get a badge!
That said, we already provide details for almost every criterion, and the "details" provide such tips. They are viewable when you fill in the form; you can also see all the details for the "passing" criteria here: https://bestpractices.coreinfrastructure.org/en/criteria?details=true
If you think they're okay but just need a sentence or 2 added in a few places, great, please propose them & add them.
If you think we need longer descriptive documents, maybe we should create an area where such documentation can be created & edited, one for each criterion where a longer description is helpful. We can then link from the details to the documentation. I'm not sure where that should go, but that's a worthwhile discussion.
As far as "getting started" goes - it's hard to figure out what that would look like, since projects start at different points. Can you tell me what you have in mind?
We could create a Slack channel on the OpenSSF Slack channel; that would be easy. I don't know if it would help enough, but we could try & see.
So, the criteria used for determining badge levels is SUPER thorough, covering a variety of best practices. Awesome!
However. It's also HELLA intimidating if you are in the seat of an open source project trying to pass said criteria. :)
The goal of this issue would be to create some "how to" / tutorial documentation to explain to maintainers:
If this is seen as a worthy idea, I'd be happy to chip away at it over time.
The text was updated successfully, but these errors were encountered: