Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a HOWTO guide / tutorial for maintainers to pass criteria #1815

Open
webchick opened this issue May 30, 2022 · 1 comment
Open

Create a HOWTO guide / tutorial for maintainers to pass criteria #1815

webchick opened this issue May 30, 2022 · 1 comment

Comments

@webchick
Copy link

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.

@david-a-wheeler
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants