-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating ODH community governance model (#14)
* docs: Updated the governance of the Open Data Hub community. Defined the new governance model for Open Data Hub. The Steering Committee will be formed to have oversight over the community. Special Interest Groups (SIGs) will be formed with well-defined charters, operating procedures, and owned code. Working Groups (WGs)will be formed to function across the SIGs. Additional details have been added such as membership (how to join and what constitutes removal) and how to recommend new SIGs or WGs. Still needs details populated after the Steering Committee and initial SIGs meet. * Fixing README * - Removed WG in favor of using just subprojects - Added necessary new lines to yaml - Cleaned up documentation in several files to make the governance more clearly understood. * - Removed WG in favor of subprojects - Cleaned documentation to make governance more clear - Added new lines to yaml files * Fix bluejeans link in the README Co-authored-by: Landon LaSmith <2432396+LaVLaS@users.noreply.github.com>
- Loading branch information
Showing
19 changed files
with
1,760 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,52 @@ | ||
| # Open Data Hub Community | ||
|
|
||
| ## Open Data Hub Guidelines | ||
| To contribute new ideas such as new features or components to Open Data Hub please follow the new [component proposal guidelines](GuidelinesForNewComponents.md). | ||
| ## Open Data Hub Community Meetings | ||
| Communty meeting for Open Data Hub are scheduled monthly on the third Monday of each month at 12:00pm EST. | ||
| Welcome to the Open Data Hub community! | ||
| This is the starting point for joining and contributing to the Open Data Hub community. | ||
| To learn more about the project structure and organization, please refer to [Governance](./governance.md) information. | ||
| The governance of this community is modeled after the [Kubernetes](https://github.com/kubernetes/community) project. | ||
| ## Communicating | ||
| The Open Data Hub community abides by the [Open Data Hub Code of Conduct](https://github.com/opendatahub-io/opendatahub-community/blob/master/CODE_OF_CONDUCT.md) on all communication platforms that we moderate listed below with noted exceptions. | ||
|
|
||
| ## Communication | ||
| Join our Open Data Hub Slack Channel with this [invite link](https://join.slack.com/t/odh-io/shared_invite/zt-13hp18gxj-Yb34PfQyP9GDmKMU7AkVYw) | ||
| Here is an excerpt from the code of conduct: | ||
|
|
||
| *In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.* | ||
|
|
||
| - **Slack** - Join us on Slack for discussions and questions at [odh-io.slack.com](https://odh-io.slack.com). | ||
| - **Mailing List** - Join the Open Data Hub mailing list [odh-community@googlegroups.com](mailto:odh-community@googlegroups.com) to keep up with the latest news and start discussions. | ||
| - **Community Meetings** - We use [Bluejeans](https://www.bluejeans.com/) for our community group meetings and contributor programs. | ||
| - **Website** - Documentation is published at [opendatahub.io](https://opendatahub.io) | ||
| - **YouTube** - Videos of Open Data Hub and other related content can be seen on the [AI/ML OpenShift YouTube channel](https://www.youtube.com/playlist?list=PLaR6Rq6Z4Iqcg2znnClv-xbj93Q_wcY8L). | ||
| - **Open Data Hub Blog** - Read various blogs about Open Data Hub and its releases on the [Open Data Hub news page](https://opendatahub.io/news.html). | ||
|
|
||
| ## Meeting Agenda and Notes | ||
| Meeting agenda can be found in the document ["Open Data Hub Community Meeting Agenda"](https://docs.google.com/document/d/1u6Kwn_uBwrlYnEE1wBkK-7USXCFuD_0IU8gKhGdfuuw/edit?usp=sharing). | ||
| To add items to the agenda, please join our [Open Data Hub Community group](https://groups.google.com/g/odh-community) so you can edit the document and add your agenda items under the meeting date title. | ||
|
|
||
| ### Add Meeting Calendar | ||
| To add the meeting notices to your calendar please add the Open Data Hub | ||
| community meeting [calendar](https://calendar.google.com/calendar?cid=cmVkaGF0LmNvbV92bW1pMW5tdHQyZGJjdXVqcmJ1aGo5N2pya0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t) to your calendar. | ||
|
|
||
| ### How to join | ||
| ## Calendar of Meetings | ||
| To see upcoming Open Data Hub events and meetings, please add the [Open Data Hub | ||
| community meeting calendar](https://calendar.google.com/calendar?cid=cmVkaGF0LmNvbV92bW1pMW5tdHQyZGJjdXVqcmJ1aGo5N2pya0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t). | ||
|
|
||
| ### How to Join | ||
| 1. Video Conferencing using bluejeans: https://bluejeans.com/563715630/3948 | ||
| 2. Audio Call: | ||
| - Dial one of the following numbers: | ||
| - 408-915-6466 (United States) | ||
| - For international numbers please visit [bluejeans](https://www.redhat.com/en/conference-numbers) | ||
| - Enter the meeting ID 563715630 # | ||
|
|
||
| ## Governance | ||
| Open Data Hub has the following types of groups that are officially supported: | ||
| - **Steering Committee** is the governing body of the Open Data Hub project tasked with taking on sensitive topics, providing strategic direction, decision-making and oversight. | ||
| - **Special Interest Groups (SIGs)** are persistent open groups that focus on a part of the project. SIGs must have open and transparent proceedings. Anyone is welcome to participate and contribute provided they follow the Open Data Hub Code of Conduct. The purpose of a SIG is to own and develop a set of subprojects. | ||
| - **Subprojects** Each SIG can have a set of subprojects. These are smaller groups that can work independently. Some subprojects will be part of the main Open Data Hub deliverables while others will be more speculative. | ||
|
|
||
| See the full [governance document](./governance.md) for more details on these groups. | ||
|
|
||
| ## Contribute | ||
| A first step to contributing is to pick from the list of Open Data Hub SIGs. Start attending SIG meetings, join the slack channel and subscribe to the mailing list. Subprojects in the SIGs will often have a set of "help wanted" issues that can help new contributors get involved. | ||
|
|
||
| The [Contributor Guide](./contributing.md) provides help on how to get your ideas and bug fixes seen and accepted. | ||
|
|
||
| ## Membership | ||
| We encourage all contributors to become members. We aim to grow an active, healthy community of contributors, reviewers, and code owners. Learn more about requirements and responsibilities of membership in our [Community Membership page](./community-membership.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,218 @@ | ||
| # Community Membership | ||
|
|
||
| This document outlines the various responsibilities of contributor roles in the | ||
| Open Data Hub community. The Open Data Hub project is subdivided into subprojects under SIGs. | ||
| Responsibilities for most roles are scoped to these subprojects. | ||
|
|
||
| | Role | Responsibilities | Requirements | Defined by | | ||
| | -----| ---------------- | ------------ | -------| | ||
| | Member | Active contributor in the community | Sponsored by 2 reviewers and multiple contributions to the project | Open Data Hub GitHub org member| | ||
| | Reviewer | Review contributions from other members | History of review and authorship in a subproject | OWNERS file reviewer entry | | ||
| | Approver | Contributions acceptance approval| Highly experienced active reviewer and contributor to a subproject | OWNERS file approver entry| | ||
| | Subproject owner | Set direction and priorities for a subproject | Demonstrated responsibility and excellent technical judgement for the subproject | [./sigs.yaml](./sigs.yaml) subproject OWNERS file *owners* entry | | ||
|
|
||
| ## New contributors | ||
|
|
||
| [New contributors](./contributing.md) should be welcomed to the community by existing members, | ||
| helped with PR workflow, and directed to relevant documentation and | ||
| communication channels. | ||
|
|
||
| ## Established community members | ||
|
|
||
| Established community members are expected to demonstrate their adherence to the | ||
| principles in this document, familiarity with project organization, roles, | ||
| policies, procedures, conventions, etc., and technical and/or writing ability. | ||
| Role-specific expectations, responsibilities, and requirements are enumerated | ||
| below. | ||
|
|
||
| ## Member | ||
|
|
||
| Members are continuously active contributors in the community. They can have | ||
| issues and PRs assigned to them, participate in SIGs through GitHub teams, and | ||
| pre-submit tests are automatically run for their PRs. Members are expected to | ||
| remain active contributors to the community. | ||
|
|
||
| **Defined by:** Member of the Open Data Hub GitHub organization | ||
|
|
||
| ### Requirements | ||
|
|
||
| - Enabled [two-factor authentication](https://help.github.com/articles/about-two-factor-authentication) on their GitHub account | ||
| - Have made multiple contributions to the project or community. Contribution may include, but is not limited to: | ||
| - Authoring or reviewing PRs on GitHub. At least one PR must be **merged**. | ||
| - Filing or commenting on issues on GitHub. | ||
| - Contributing to SIG, subproject, or community discussions (e.g. meetings, Slack, email discussion forums). | ||
| - Subscribed to [odh-community@googlegroups.com](mailto:odh-community@googlegroups.com). | ||
| - Have read the [contributor guide](./contributing.md). | ||
| - Actively contributing to 1 or more subprojects. | ||
| - Sponsored by 2 reviewers. **Note the following requirements for sponsors**: | ||
| - Sponsors must have close interactions with the prospective member - e.g. code/design/proposal review, coordinating on issues, etc. | ||
| - Sponsors must be reviewers or approvers in at least one OWNERS file within one of the Open Data Hub GitHub organizations. | ||
| - **Submit a membership request to [odh-community@googlegroups.com](mailto:odh-community@googlegroups.com)** | ||
| - Ensure your sponsors are @mentioned on the issue | ||
| - Complete every item on the checklist ([preview the current version of the template](./membership.yaml)) | ||
| - Make sure that the list of contributions included is representative of your work on the project. | ||
| - Have your sponsoring reviewers reply confirmation of sponsorship: `+1` | ||
| - Once your sponsors have responded, your request will be reviewed by the Open Data Hub GitHub Admin team within a reasonable amount of time. Any missing information will be requested. | ||
|
|
||
| ### Responsibilities and privileges | ||
|
|
||
| - Responsive to issues and PRs assigned to them. | ||
| - Responsive to mentions of SIG teams of which they are members. | ||
| - Active owner of code they have contributed (unless ownership is explicitly transferred) | ||
| - Code is well tested | ||
| - Tests consistently pass | ||
| - Addresses bugs or issues discovered after code is accepted. | ||
| - Members can do `/lgtm` on open PRs. | ||
| - They can be assigned to issues and PRs, and people can ask members for reviews. | ||
| - Tests can be run against their PRs automatically. | ||
|
|
||
| **Note:** members who frequently contribute code are expected to proactively | ||
| perform code reviews and work towards becoming a primary *reviewer* for the | ||
| subproject that they are active in. | ||
|
|
||
| ## Reviewer | ||
|
|
||
| Reviewers are able to review code for quality and correctness on some part of a | ||
| subproject. They are knowledgeable about both the codebase and software | ||
| engineering principles. | ||
|
|
||
| **Defined by:** *reviewers* entry in an OWNERS file in a repo owned by the | ||
| Open Data Hub project. | ||
|
|
||
| Reviewer status is scoped to a part of the codebase. | ||
|
|
||
| **Note:** Acceptance of code contributions requires at least one approver in | ||
| addition to the assigned reviewers. | ||
|
|
||
| ### Requirements | ||
|
|
||
| The following apply to the part of codebase for which one would be a reviewer in | ||
| an OWNERS file. | ||
|
|
||
| - member for at least 3 months. | ||
| - Primary reviewer for at least 5 PRs to the codebase. | ||
| - Reviewed or merged at least 20 substantial PRs to the codebase. | ||
| - Knowledgeable about the codebase. | ||
| - Sponsored by a subproject approver | ||
| - With no objections from other approvers. | ||
| - Done through PR to update the OWNERS file. | ||
| - May either self-nominate, be nominated by an approver in this subproject. | ||
|
|
||
| ### Responsibilities and privileges | ||
|
|
||
| The following apply to the part of codebase for which one would be a reviewer in | ||
| an OWNERS file. | ||
|
|
||
| - Tests are automatically run for PullRequests from members of the Open Data Hub GitHub organization. | ||
| - Code reviewer status may be a precondition to accepting large code contributions. | ||
| - Responsible for project quality control via code reviews. | ||
| - Focus on code quality and correctness, including testing and factoring. | ||
| - May also review for more holistic issues, but not a requirement. | ||
| - Expected to be responsive to review requests. | ||
| - Assigned PRs to review related to subproject of expertise. | ||
| - Assigned test bugs related to subproject of expertise. | ||
| - Granted "read access" to Open Data Hub repository. | ||
| - May get a badge on PR and issue comments. | ||
|
|
||
| ## Approver | ||
|
|
||
| Code approvers are able to both review and approve code contributions. While | ||
| code review is focused on code quality and correctness, approval is focused on | ||
| holistic acceptance of a contribution including: backwards / forwards | ||
| compatibility, adhering to API and flag conventions, subtle performance and | ||
| correctness issues, interactions with other parts of the system, etc. | ||
|
|
||
| **Defined by:** *approvers* entry in an OWNERS file in a repository owned by the | ||
| Open Data Hub project. | ||
|
|
||
| Approver status is scoped to a part of the codebase. | ||
|
|
||
| ### Requirements | ||
|
|
||
| The following apply to the part of codebase for which one would be an approver | ||
| in an OWNERS file. | ||
|
|
||
| - Reviewer of the codebase for at least 3 months | ||
| - Primary reviewer for at least 10 substantial PRs to the codebase | ||
| - Reviewed or merged at least 30 PRs to the codebase | ||
| - Nominated by a subproject owner | ||
| - With no objections from other subproject owners | ||
| - Done through PR to update the top-level OWNERS file | ||
|
|
||
| ### Responsibilities and privileges | ||
|
|
||
| The following apply to the part of codebase for which one would be an approver | ||
| in an OWNERS file. | ||
|
|
||
| - Approver status may be a precondition to accepting large code contributions. | ||
| - Demonstrate sound technical judgement. | ||
| - Responsible for project quality control via code reviews. | ||
| - Focus on holistic acceptance of contribution such as dependencies with other features, backwards / forwards | ||
| compatibility, API and flag definitions, etc. | ||
| - Expected to be responsive to review requests. | ||
| - Mentor contributors and reviewers. | ||
| - May approve code contributions for acceptance. | ||
|
|
||
| ## Subproject Owner | ||
|
|
||
| Subproject Owners are the technical authority for a subproject in the Open Data Hub | ||
| project. They *MUST* have demonstrated both good judgement and responsibility | ||
| towards the health of that subproject. Subproject Owners *MUST* set technical | ||
| direction and make or approve design decisions for their subproject - either | ||
| directly or through delegation of these responsibilities. | ||
|
|
||
| **Defined by:** *owners* entry in subproject OWNERS files as defined by [sigs.yaml](./sigs.yaml) *subproject.owners* | ||
|
|
||
| ### Requirements | ||
|
|
||
| The process for becoming an subproject Owner should be defined in the SIG | ||
| charter of the SIG owning the subproject. Unlike the roles outlined above, the | ||
| Owners of a subproject are typically limited to a relatively small group of | ||
| decision makers and updated as fits the needs of the subproject. | ||
|
|
||
| The following apply to the subproject for which one would be an owner. | ||
|
|
||
| - Deep understanding of the technical goals and direction of the subproject. | ||
| - Deep understanding of the technical domain of the subproject. | ||
| - Sustained contributions to design and direction by doing all of: | ||
| - Authoring and reviewing proposals. | ||
| - Initiating, contributing and resolving discussions (emails, GitHub issues, meetings). | ||
| - Identifying subtle or complex issues in designs and implementation PRs. | ||
| - Directly contributed to the subproject through implementation and/or review. | ||
|
|
||
| ### Responsibilities and privileges | ||
|
|
||
| The following apply to the subproject for which one would be an owner. | ||
|
|
||
| - Make and approve technical design decisions for the subproject. | ||
| - Set technical direction and priorities for the subproject. | ||
| - Define milestones and releases. | ||
| - Mentor and guide approvers, reviewers, and contributors to the subproject. | ||
| - Ensure continued health of subproject | ||
| - Adequate test coverage to confidently release. | ||
| - Tests are passing reliably (i.e. not flaky) and are fixed when they fail. | ||
| - Ensure a healthy process for discussion and decision making is in place. | ||
| - Work with other subproject owners to maintain the project's overall health and success holistically | ||
|
|
||
| ## Inactive members | ||
|
|
||
| _Members are continuously active contributors in the community._ | ||
|
|
||
| A core principle in maintaining a healthy community is encouraging active | ||
| participation. It is inevitable that people's focuses will change over time and | ||
| they are not expected to be actively contributing forever. | ||
|
|
||
| However, being a member of one of the Open Data Hub GitHub organizations comes with | ||
| an elevated set of permissions. These capabilities should not be used by those | ||
| that are not familiar with the current state of the Open Data Hub project. | ||
|
|
||
| Therefore members with an extended period away from the project with no activity | ||
| will be removed from the Open Data Hub Github Organizations and will be required to | ||
| go through the org membership process again after re-familiarizing themselves | ||
| with the current state. | ||
|
|
||
|
|
||
| ### How inactivity is measured | ||
|
|
||
| Inactive members are defined as members of one of the Open Data Hub Organizations | ||
| with **no** contributions across any organization within 18 months. Both code and non-code contributions should be evaluated. |
Oops, something went wrong.