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

Foundation groups documentation audit #162

Closed
SecurityCRob opened this issue May 13, 2023 · 10 comments
Closed

Foundation groups documentation audit #162

SecurityCRob opened this issue May 13, 2023 · 10 comments
Assignees
Labels
administration documentation Improvements or additions to documentation For Review help wanted Extra attention is needed

Comments

@SecurityCRob
Copy link
Contributor

A short-lived working committee should be created under the TAC for the purpose of conducting a review to ensure existence, consistency, and accuracy for all Foundation group documentations (TAC, WG, SIG, SIF, AP, Committees, etc.). This should include, but not be limited to the following artifacts:

  • clear readme.md file that provides overview of group, with meeting times, communication channels, all active & past work, and areas where contributions are desired, any sub-groups affiliated with the higher-level working group, group leader(s), designated TAC liaison that assists the group
  • a clearly discoverable list of active members, their project level (maintainer, collaborator, contributor, etc) as well as membership criteria and voting procedures
  • an up-to-date and approved group charter.md
  • a security.md file that documents project defect and vulnerability reporting process (sourced from approved foundation template)
  • other artifacts or documentation that is deemed necessary by the committee
@SecurityCRob SecurityCRob added documentation Improvements or additions to documentation help wanted Extra attention is needed administration For Review labels May 13, 2023
@hythloda
Copy link
Member

hythloda commented May 16, 2023

This was brought up in the TAC with @steiza @jchestershopify @lehors @hythloda volunteering to help
Do want a zoom meeting to get this started? Or async?

@lehors
Copy link
Contributor

lehors commented May 24, 2023

It's not that I really want a zoom meeting (who does?? :) but I think we may need it to get things really going. Otherwise I fear time will just go by without anything happening.

@jchester
Copy link

A nit: the best handle to use for me right now is this one; @jchestershopify is (as the name suggests) tied to my previous work for Shopify.

@di
Copy link
Member

di commented May 30, 2023

For projects of the OpenSSF, should we add a "contributor ladder" to the list of artifacts? AFAIK Allstar is the only project that approaches this, I think this would be good to roughly standardize across all projects.

@bobcallaway
Copy link
Contributor

For projects of the OpenSSF, should we add a "contributor ladder" to the list of artifacts? AFAIK Allstar is the only project that approaches this, I think this would be good to roughly standardize across all projects.

sigstore also publishes one: https://github.com/sigstore/community/blob/main/MEMBERSHIP.md

@di
Copy link
Member

di commented May 30, 2023

Aha, thanks. (We might also want to align on what this document is called, to help with discoverability 😉)

@di
Copy link
Member

di commented May 30, 2023

Perhaps this is also an opportunity to make a template repository that can be used for new GitHub repositories?

@hythloda
Copy link
Member

hythloda commented Jun 1, 2023

We have a WIP proposal for what sections each should have. We would love comments!

@jeffmendoza
Copy link
Member

Allstar can enforce security.md and branch protection currently. We can add more features as needed as well.

@SecurityCRob
Copy link
Contributor Author

As TIs are reporting in quarterly, part of that process is a docs review/check to ensure that group has completed all the necessary tasks. This review should be complete by the end of Q3.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
administration documentation Improvements or additions to documentation For Review help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

10 participants