Skip to content

Commit 0d895b5

Browse files
authored
Merge pull request #75 from bmicklea/cncf-onboarding
CNCF onboarding
2 parents cbd6db5 + 09db119 commit 0d895b5

2 files changed

Lines changed: 91 additions & 2 deletions

File tree

GOVERNANCE.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Project Governance
2+
3+
The ModelSpec project is dedicated to creating a universal, vendor-neutral standard for packaging, versioning, and running AI/ML projects that aligns with the OCI specification. The ModelSpec is especially important for organizations who are self-hosting models (open source, or self-built) and want to be able to use the tools and processes they've proven with containers, to manage their AI/ML project lifecycle.
4+
5+
This is not an implementation, it is the specification on which compliant implementations can be built.
6+
7+
This governance document explains how the project is run.
8+
9+
- [Values](#values)
10+
- [Maintainers](#maintainers)
11+
- [Becoming a Maintainer](#becoming-a-maintainer)
12+
- [Meetings](#meetings)
13+
- [Code of Conduct Enforcement](#code-of-conduct)
14+
- [Modifications](#modifying-this-charter)
15+
16+
## Values
17+
18+
The ModelSpec project leadership embraces the following values:
19+
20+
- **Openness**: Communication and decision-making happens in the open and is discoverable for future reference. As much as possible, all discussions and work take place in public forums and open repositories.
21+
22+
- **Fairness**: All stakeholders have the opportunity to provide feedback and submit contributions, which will be considered on their merits.
23+
24+
- **Community over Product or Company**: Sustaining and growing our community takes priority over shipping code or sponsors' organizational goals. Each contributor participates in the project as an individual.
25+
26+
- **Inclusivity**: We innovate through different perspectives and skill sets, which can only be accomplished in a welcoming and respectful environment.
27+
28+
- **Participation**: Responsibilities within the project are earned through participation, and there is a clear path up the contributor ladder into leadership positions.
29+
30+
## Maintainers
31+
32+
ModelSpec maintainers have write access to the [project GitHub repository](https://github.com/modelpack/model-spec). They can merge patches and are expected to review large or critical patches personally. The current maintainers can be found in [MAINTAINERS.md](./MAINTAINERS.md). Maintainers collectively manage the project's resources and contributors.
33+
34+
This privilege is granted with some expectation of responsibility: maintainers are people who care about the ModelSpec project and want to help it grow and improve. A maintainer is not just someone who can make changes, but someone who has demonstrated good judgement and an ability to collaborate with the team, get the most knowledgeable people to review code and docs, contribute high-quality code, and follow through to fix issues (in code or tests).
35+
36+
A maintainer is a contributor to the project's success and a citizen helping the project succeed.
37+
38+
The collective team of all Maintainers is known as the **Maintainer Council**, which is the governing body for the project.
39+
40+
### Becoming a Maintainer
41+
42+
To become a Maintainer you need to demonstrate the following:
43+
44+
- **Commitment to the project**:
45+
- Participate actively and impactfully in discussions, contributions, code and documentation reviews `this will need quantifying eventually`
46+
- Perform useful reviews for a significant number of non-trivial pull requests `this will need quantifying eventually`
47+
- Contribute non-trivial pull requests and have them merged `this will need quantifying eventually`
48+
- Ability to write quality code and/or documentation
49+
- Ability to collaborate with the team
50+
- Understanding of how the team works (policies, processes for testing and code review, etc)
51+
- Understanding of the project's code base and coding and documentation style
52+
53+
A new Maintainer must be proposed by an existing maintainer by opening an issue with the title "New Maintainer Proposal". A 2/3 vote of existing Maintainers approves the application. Maintainers nominations will be evaluated without prejudice to employer or demographics.
54+
55+
Maintainers who are selected will be granted the necessary GitHub rights.
56+
57+
### Removing a Maintainer
58+
59+
Maintainers may resign at any time if they feel that they will not be able to continue fulfilling their project duties.
60+
61+
Maintainers may also be removed after being inactive, failing to fulfill their Maintainer responsibilities, violating the [Code of Conduct](./code-of-conduct.md), or other reasons. Inactivity is defined as a period of very low or no activity in the project for a year or more, with no definite schedule to return to full Maintainer activity.
62+
63+
A Maintainer may be removed at any time by a 2/3 vote of the remaining maintainers.
64+
65+
Depending on the reason for removal, a Maintainer may be converted to **Emeritus** status. Emeritus Maintainers will still be consulted on some project matters and can be rapidly returned to Maintainer status if their availability changes.
66+
67+
## Meetings
68+
69+
Time zones permitting, Maintainers are expected to participate in the ModelSpec office hours virtual meeting, which occurs bi-weekly on Thursday at 10:00ET.
70+
71+
### ModelSpec Public Office Hours (bi-weekly)
72+
73+
**Every second Thursday @ 14:00 - 15:00**
74+
**Time zone**: UTC
75+
**Video call link**: [Zoom](https://us06web.zoom.us/j/89085916734?pwd=dBaeMvmg9SyWvWj5Caf2i1bNaCf2oJ.1)
76+
**Meeting ID**: 890 8591 6734
77+
**Passcode**: 274899
78+
79+
Maintainers may also have closed meetings in order to discuss sensitive matters or Code of Conduct violations. Such meetings should be scheduled by any Maintainer on receipt of a CoC report. All current Maintainers must be invited to such closed meetings, except for any Maintainer who is accused of a CoC violation.
80+
81+
## Code of Conduct
82+
83+
Everything we do in the ModelSpec community is governed by our [Code of Conduct](./code-of-conduct.md). Violations by community members will be discussed and resolved by the Maintainers in their private Discord channel. If a Maintainer is directly involved in the report, the Maintainers will instead designate two Maintainers to resolve the issue.
84+
85+
## Modifying this Charter
86+
87+
Changes to this Governance and its supporting documents may be approved by a 2/3 vote of the Maintainers.

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,12 @@ Apache 2.0 License. Please see [LICENSE](LICENSE) for more information.
2727

2828
You can engage with this project by joining the discussion on our Slack channel: [#modelpack](https://cloud-native.slack.com/archives/C07T0V480LF) in the [CNCF Slack workspace](https://slack.cncf.io/).
2929

30+
This project holds inclusivity, empathy, and responsibility at our core. We follow the CNCF's [Code of Conduct](./code-of-conduct.md), you can read it to understand the values guiding our community.
31+
32+
The rules governing this project can be found in the [Governance policy document](./GOVERNANCE.md)
33+
3034
## Contributing
3135

3236
Any feedback, suggestions, and contributions are welcome. Please feel free to open an issue or pull request.
3337

3438
Especially, we look forward to integrating the model specification with different model registry implementations (like [Harbor](https://goharbor.io/) and [Kubeflow model registry](https://www.kubeflow.org/docs/components/model-registry/overview/)), as well as existing model centric infrastructure projects like [Huggingface](https://huggingface.co/), [KitOps](https://kitops.ml/), [Kubeflow](https://www.kubeflow.org/), [Lepton](https://www.lepton.ai/), [Ollama](https://github.com/ollama/ollama), [ORAS](https://oras.land/), and others.
35-
36-
Enjoy!

0 commit comments

Comments
 (0)