kserve / kserve/community

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

Open
#39 0 comments 0 reactions 0 assignees View on GitHub
cncf-incubation
Dominant language
Python
Stars
17
Forks
10
Avg merge
1h 36m
Merged PRs (30d)
1

Description

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`](https://github.com/kserve/community/blob/05a5b44b3f7cc2e314ed2a97b467fd3ca18d6b6b/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`](https://github.com/kserve/community/blob/05a5b44b3f7cc2e314ed2a97b467fd3ca18d6b6b/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.
4. [`ROLES.md`](https://github.com/kserve/community/blob/05a5b44b3f7cc2e314ed2a97b467fd3ca18d6b6b/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.
5. ``
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`](https://github.com/kserve/community/blob/05a5b44b3f7cc2e314ed2a97b467fd3ca18d6b6b/TECHNICAL-STEERING-COMMITTEE.md) (which lists all TSC members), [`maintainers.md`](https://github.com/kserve/community/blob/05a5b44b3f7cc2e314ed2a97b467fd3ca18d6b6b/MAINTAINERS.md) (which lists all the maintainers),

Related to: https://github.com/cncf/toc/issues/1367

Contributor guide

Open the contributing guide

Research direction

Start by comparing KSERVE-TECHNICAL-CHARTER.md, membership.md, ROLES.md, TECHNICAL-STEERING-COMMITTEE.md, and MAINTAINERS.md to identify overlapping governance and role information. Review the related issue for context. Done means the documents have distinct focuses, relevant cross-links and descriptions, consolidated role definitions, and a consistent format for member lists.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.