KubeGene Community Roles

This document describes the set of roles individuals may have within the KubeGene community, the requirements of each role, and the privileges that each role grants.

Role summary

Here is the set of roles we use within the KubeGene community, the general responsibilities expected by individuals in each role, the requirements necessary to join or stay in a given role, and the concrete manifestation of the role in terms of permissions and privileges. To request membership to the KubeGene organization, please open an issue and fill out the required template within the issue. Further, you may self-nominate to be an approver by opening an issue with a list of your key contributions.

Role Responsibilities Requirements Privileges
Collaborator Casual contributor to the project n/a

Outside collaborator of the GitHub KubeGene organization

Can submit PRs

Read and commenting permission on the KubeGene Team drive

Member Regular active contributor in the community

Sponsored by 2 existing members

Has made multiple contributions to the project

Member of the GitHub KubeGene organization

Member of the KubeGene Slack workspace

Edit permission on the KubeGene Team drive

Approver Approve contributions from other members Highly experienced and active reviewer and contributor to an area ‘approver’ entry in one or more OWNERS file in GitHub
Lead

Set priorities for a functional area and approve proposals

Triage incoming issues, set milestones, repo labels

Run their working group

Appointed by the technical oversight committee Write permissions on one or more repos, allowing issues to be manipulated.
Administrator Manage & control permissions Appointed by the technical oversight committee

Admin privileges on the GitHub KubeGene org and all its repos

Admin privileges on the KubeGene Slack workspace

Admin privileges on the KubeGene Team Drive

Admin privilege to the KubeGene email lists.

Collaborator

Individuals may be added as an outside collaborator (with READ access) to a repo in the KubeGene GitHub organization without becoming a member. This allows them to be assigned issues and PRs until they become a member, but will not allow tests to be run against their PRs automatically nor allow them to interact with the PR bot.

Requirements

  • Working on some contribution to the project that would benefit from the ability to have PRs or Issues to be assigned to the contributor

  • Sponsored by 1 member

Member

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.

Members are continuously active contributors in the community. They can have issues and PRs assigned to them, participate in working group meetings, and pre-submit tests are automatically run for their PRs. Members are expected to remain active contributors to the community.

All members are encouraged to help with the code review burden, although each PR must be reviewed by one or more official approvers for the area.

Requirements

  • Has made multiple contributions to the project or community. Contributions may include, but are not limited to:

    • Authoring or reviewing PRs on GitHub

    • Filing or commenting on issues on GitHub

    • Contributing to working group or community discussions

  • Subscribed to kubegene-dev@googlegroups.com

  • Actively contributing to 1 or more areas.

  • Sponsored by 2 members.

Responsibilities and privileges

  • Responsive to issues and PRs assigned to them

  • 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 who frequently contribute code are expected to proactively perform code reviews for the area that they are active in.

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. Approver status is scoped to a part of the codebase.

Requirements

The following apply to the part of the codebase for which one would be an approver in an OWNERS file:

  • Member for at least 3 months

  • Contributed at least 30 substantial PRs to the codebase

  • Knowledgeable about the codebase

  • Nominated by an area lead

    • With no objections from other leads

    • Done through PR to update an OWNERS file

Responsibilities and privileges

The following apply to the part of the 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 code quality and correctness, including testing and factoring

    • 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 as per community expectations;

  • May approve code contributions for acceptance

Lead

Working group leads, or just ‘leads’, are approvers of an entire area that have demonstrated good judgement and responsibility. Leads accept design proposals and approve design decisions for their area of ownership.

Requirements

Getting to be a lead of an existing working group:

  • Recognized as having expertise in the group’s subject matter

  • Approver for some part of the codebase for at least 3 months

  • Member for at least 1 year (relevant as KubeGene ages a bit more)

  • Primary reviewer for 20 substantial PRs

  • Reviewed or merged at least 50 PRs

  • Appointed by the technical oversight committee

Establishing the leads for a new working group:

  • Originally authored or contributed major functionality to an area

  • An approver in the top-level OWNERS file for the group’s code

  • Approver for some part of the codebase for at least 3 months

  • Member for at least 1 year

  • Primary reviewer for 20 substantial PRs

  • Reviewed or merged at least 50 PRs

  • Appointed by the technical oversight committee

Responsibilities and privileges

The following apply to the area / component for which one would be an owner.

  • Run their working group as outlined in the Working Group Processes document.

  • Design/proposal approval authority over the area / component, though escalation to the technical oversight committee is possible

  • Perform issue triage on GitHub

  • Apply/remove/create/delete GitHub labels and milestones

  • Write access to repo (assign issues/PRs, add/remove labels and milestones, edit issues and PRs, edit wiki, create/delete labels and milestones)

  • Capable of directly applying lgtm + approve labels for any PR

    • Expected to respect OWNERS files approvals and use standard procedure for merging code
  • Expected to work to holistically maintain the health of the project through:

    • Reviewing PRs

    • Fixing bugs

    • Mentoring and guiding approvers, members, and contributors

Administrator

Administrators are responsible for the bureaucratic aspects of the project.

Requirements

  • Appointed by the technical oversight committee

Responsibilities and privileges

  • Manage the KubeGene GitHub repo, including granting membership, controlling repo read/write permissions, and team membership

  • Manage the KubeGene developer Slack workspace

  • Manage the KubeGene Google group forums