Skip to content

[Recommended] Clarify the focuses and relationships between mutiple governance relevant docs #39

@kevin-wangzefeng

Description

@kevin-wangzefeng

Hello KServe community, thanks for fixing the governance issues found quickly.

Since you now have multiple files outlining your community governance, I suggest you doulbe-check (and update ondemand) whether all the files have clear focuses, and if they cross-link to each other with descriptions, clarifying the relationships between them where necessary.

Here's a potential focus for each file:

  1. KSERVE-TECHNICAL-CHARTER.md
    i. This document should serve as the overarching governance document. It could focus on describing your core values, governance model, code of conduct, and relevant decision-making processes.
    ii. It would also be helpful to include a list of all governance-related documents with brief descriptions.
  2. membership.md
    i. This document should focus on the contributor ladder, including definitions for all community roles, as well as the requirements and processes for recruitment, promotion, and retirement within those roles.
    ii. It appears that not all role definitions are currently included here, with some residing in ROLES.md. I suggest merging all role definitions into this file for better organization.
    iii. Cross-linking to relevant issue templates such as "Membership Request," "Approver Promotion Request," and "Reviewer Promotion Request" would also be beneficial.
  3. ROLES.md
    i. This file seems to overlap with membership.md but also includes a wider range of roles than the latter. As mentioned above, merging its content into membership.md would likely improve clarity.
  4. <role members list files>
    i. I recommend adopting a consistent format for listing members within each role. You could have one or more files dedicated to each role (or combine them as needed) and ensure they are cross-linked from membership.md.
    ii. Good examples of this approach include TECHNICAL-STEERING-COMMITTEE.md (which lists all TSC members), maintainers.md (which lists all the maintainers),

Related to: cncf/toc#1367

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions