Skip to content

Commit

Permalink
add GOVERNANCE-maintainer.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cyclinder committed Dec 14, 2023
1 parent 5b13a48 commit e43fb25
Show file tree
Hide file tree
Showing 2 changed files with 126 additions and 1 deletion.
1 change: 0 additions & 1 deletion CONTRIBUTOR-ROLES.md
Original file line number Diff line number Diff line change
@@ -1 +0,0 @@

126 changes: 126 additions & 0 deletions GOVERNANCE-maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
# Spiderpool Project Governance

The Spiderpool project is dedicated to creating a underlay and RDMA network solution of the Kubernetes, for bare metal, VM and any public cloud. This governance explains how the project is run.

- [Values](#values)
- [Maintainers](#maintainers)
- [Becoming a Maintainer](#becoming-a-maintainer)
- [Meetings](#meetings)
- [CNCF Resources](#cncf-resources)
- [Code of Conduct Enforcement](#code-of-conduct)
- [Modifications](#modifying-this-charter)

## Values

The Spiderpooland its leadership embrace the following values:

- 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.

- Fairness: All stakeholders have the opportunity to provide feedback and submit
contributions, which will be considered on their merits.

- 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.

- Inclusivity: We innovate through different perspectives and skill sets, which
can only be accomplished in a welcoming and respectful environment.

- Participation: Responsibilities within the project are earned through
participation, and there is a clear path up the contributor ladder into leadership
positions.

## Maintainers

Spiderpool Maintainers have write access to the [Spiderpool](https://github.com/spidernet-io/spiderpool).
They can merge their own patches or patches from others. The current maintainers
can be found in [MAINTAINERS.md](https://github.com/spidernet-io/spiderpool/blob/main/MAINTAINERS.md). Maintainers collectively manage the project's
resources and contributors.

This privilege is granted with some expectation of responsibility: maintainers
are people who care about the Spiderpool project and want to help it grow and
improve. A maintainer is not just someone who can make changes, but someone who
has demonstrated their 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).

A maintainer is a contributor to the project's success and a citizen helping
the project succeed.

The collective team of all Maintainers is known as the Maintainer Council, which
is the governing body for the project.

### Becoming a Maintainer

To become a Maintainer you need to demonstrate the following:

- commitment to the project:
- participate in discussions, contributions, code and documentation reviews
for 6 month or more,
- perform reviews for 20 non-trivial pull requests,
- contribute 20 non-trivial pull requests and have them merged,
- ability to write quality code and/or documentation,
- ability to collaborate with the team,
- understanding of how the team works (policies, processes for testing and code review, etc),
- understanding of the project's code base and coding and documentation style.

A new Maintainer must be proposed by an existing maintainer by sending a message to the
[[email protected]]([email protected]). A simple majority vote of existing Maintainers
approves the application. Maintainers nominations will be evaluated without prejudice
to employer or demographics.

Maintainers who are selected will be granted the necessary GitHub rights,
and invited to the [[email protected]]([email protected]).

### Removing a Maintainer

Maintainers may resign at any time if they feel that they will not be able to
continue fulfilling their project duties.

Maintainers may also be removed after being inactive, failure to fulfill their
Maintainer responsibilities, violating the Code of Conduct, 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.

A Maintainer may be removed at any time by a 2/3 vote of the remaining maintainers.

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.

## Meetings

Time zones permitting, Maintainers are expected to participate in the public
developer meeting, which occurs
[Google Docs](https://docs.google.com/document/d/1tpNzxRWOz9-jVd30xGS2n5X02uXQuvqJAdNZzwBLTmI/edit).

Maintainers will also have closed meetings in order to discuss security reports
or Code of Conduct violations. Such meetings should be scheduled by any
Maintainer on receipt of a security issue or CoC report. All current Maintainers
must be invited to such closed meetings, except for any Maintainer who is
accused of a CoC violation.

## CNCF Resources

Any Maintainer may suggest a request for CNCF resources, either in the
[MAINTAINERS](https://github.com/spidernet-io/spiderpool/blob/main/MAINTAINERS.md), or during a
meeting. A simple majority of Maintainers approves the request. The Maintainers
may also choose to delegate working with the CNCF to non-Maintainer community
members, who will then be added to the [CNCF's Maintainer List](https://github.com/cncf/foundation/blob/main/project-maintainers.csv)
for that purpose.

## Code of Conduct

[Code of Conduct](./CODE-OF-CONDUCT.md)
violations by community members will be discussed and resolved
on the [private Maintainer mailing list](TODO). If a Maintainer is directly involved
in the report, the Maintainers will instead designate two Maintainers to work
with the CNCF Code of Conduct Committee in resolving it.

## Modifying this Charter

Changes to this Governance and its supporting documents may be approved by
a 2/3 vote of the Maintainers.

0 comments on commit e43fb25

Please sign in to comment.