Skip to content

Latest commit

 

History

History
126 lines (83 loc) · 8.03 KB

MEMBERSHIP.md

File metadata and controls

126 lines (83 loc) · 8.03 KB
Raw

Community roles and membership

This document outlines the various responsibilities of contributor roles in the OSCAL Compass organization. OSCAL Compass is made up of several projects that are defined as codebases and services with different release cycles, thus the responsibilities for roles are scope to individual projects. Where applicable for OSCAL Compass overall, contributor status is equal to the highest status that they have on any project.

This document outlines a core number of contributor roles for OSCAL Compass projects, such as Member, Triager, and Maintainer. An Oversight Committee also serves to supervise the overall OSCAL Compass project and its health. Using transparent criteria, the journey between roles is based on individual participation. Criteria will be reevaluated periodically to ensure that we can meet the needs of each project with the resources available to contribute.

OSCAL Compass welcomes new contributors. Not all contributors are able to provide sustained contribution, but each contribution is welcome. Established contributors are expected to demonstrate their adherence to the criteria in this document, familiarity with project organization, roles, policies, etc., and technical and/or writing ability. Role-specific expectations, responsibilities, and requirements are explained below.

Current roles

The following table provides information about the current roles available to the OSCAL Compass project.

Role Responsibilities Requirements Defined by
Member Active contributor in the community Multiple contributions and sponsored by 2 Maintainers OSCAL Compass GitHub org member
Triager Triaging issues and PRs History of issue and PR triage and sponsored by 2 Maintainers OSCAL Compass GitHub Triage team member
Maintainer Sets direction and priorities for a project Demonstrated responsibility and excellent technical judgement. Nominated and approved by Maintainers team. MAINTAINERS.md file on project level

Member

Members are active contributors in the community. They can have issues and pull requests (PRs) assigned to them. Members are expected to be active contributors to the community.

Member requirements

To become a project Member, you must meet the following requirements:

  • You have 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 community discussion, for example, meetings or on Slack.

  • You have been sponsored by two Maintainers.

If you have met these expectations and wish to become an established member, you can be nominated by a contributor, or you can nominate yourself. To nominate a contributor or yourself:

  • Open an issue in the repository of interest detailing contributions to the project so far.
  • Ensure that the sponsors are @mentioned on the issue.
  • Make sure that the list of contributions included is representative of the work on the project.

Member responsibilities and privileges

As a project Member, you have the following responsibilities and privileges:

  • You are responsive to issues and the pull requests assigned to them.
  • You are an active owner of code that you have contributed, unless ownership is explicitly transferred:
    • You provide code that consistently pass tests.
    • You consistently address bugs or issues that are discovered after code has been accepted.

Triager

Triagers are active contributors in the community through issue and pull request triage. Triagers are expected to remain active in this task.

Triager requirements

To become a project Triager, you must meet the following requirements:

  • You have made multiple contributions to the project or community. Contribution may include, but is not limited to:

    • Triaging open issues or PRs.
    • Authoring or reviewing PRs on GitHub.
    • Contributing to community discussions (e.g. meetings, Slack).

  • You have been sponsored by two Maintainers.

Any person who meets the requirements may be nominated by a contributor, including themselves. To nominate a contributor or yourself:

  • Open an issue in the repository of interest detailing contributions to the project so far.
  • Ensure that the sponsors are @mentioned on the issue.
  • Make sure that the list of contributions included is representative of the work on the project.

Triager responsibilities and privileges

As a project Triager, you have the following responsibilities and privileges:

  • You have permission to label issues and PRs.
  • You consistently assign, close, and reopen issues or PRs.
  • You actively triage issues and PRs with high quality.

Maintainer

Maintainers are first and foremost contributors that have shown they are committed to the long term success of a project. Maintainership is about building trust with the community and being a person that everyone can depend on to make consistent decisions in the best interest of the project.

Maintainer requirements

To become a project Maintainer, you must meet the following requirements:

  • You have been a Member for at least 1 month.
  • You have a deep understanding of the technical goals and direction of the project.
  • You have a deep understanding of the technical domain of the project.
  • You have made sustained contributions to design and direction by:
    • Authoring and reviewing proposals.
    • Initiating, contributing, and resolving discussions, such as emails, Slack, GitHub issues, meetings.
    • Identifying subtle or complex issues in designs and implementation pull requests.
  • You have directly contributed to the project through implementation and/or review.
  • You have been sponsored by two Maintainers.

One of the sponsors should open an pull request in the relevant repository to add the nominee to the MAINTAINERS.md file and add relevant details per the requirements.

Maintainers will vote publicly on the pull request, expressing their support via a GitHub comment or emoji reaction to the nomination summary. Any concerns may be discussed privately amongst the existing Maintainer team. If feedback needs to be given to the nominee, the sponsor should provide that feedback privately. Upon a decision, the pull request will be merged or closed.

Maintainer responsibilities and Privileges

As a project Maintainer, you have the following responsibilities and privileges:

  • You make and approve technical design decisions.
  • You set technical direction and priorities.
  • You define milestones and releases.
  • You mentor and guide contributors to the project, including mentoring and sponsoring potential Triager and Maintainer candidates.
  • You ensure the continued health of the project.
  • You are responsive to review requests.
  • You review assigned PRs that are related to your area of expertise.
  • You focus on quality and correctness, including testing code and factoring content.
  • You are responsible for project quality control via code reviews.
  • You perform adequate test coverage to confidently release.
  • The tests that you perform are passing reliably (i.e. not flaky) and are fixed when they fail.
  • You ensure that a healthy process for discussion and decision making is in place.
  • You work with other Maintainers to maintain the project's overall health and success holistically.
  • Unless otherwise specified, you will be provided with permission to merge commits to the project repository branches.

Changes to contributor roles

Changes to contributor roles must be approved by a vote of the Oversight Committee or a majority of the current project's Maintainers.

Acknowledgements

Contributor roles and responsibilities were adapted from InstructLab contributor roles