Skip to content

Commit

Permalink
*: create project governance
Browse files Browse the repository at this point in the history
Create project governance.
  • Loading branch information
spzala committed Sep 24, 2019
1 parent 1291387 commit 2a266c7
Show file tree
Hide file tree
Showing 4 changed files with 98 additions and 37 deletions.
88 changes: 88 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# etcd Governance

## Principles

The etcd community adheres to the following principles:

- Open: etcd is open source.
- Welcoming and respectful: See [Code of Conduct](code-of-conduct.md).
- Transparent and accessible: Changes to the etcd code repository and CNCF related
activities (e.g. level, involvement, etc) are done in public.
- Merit: Ideas and contributions are accepted according to their technical merit for
the betterment of the project. For specific guidance on practical contribution steps
please see [CONTRIBUTING](./CONTRIBUTING.md) guide.

## Maintainers

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
current maintainers of the project and being a person that they can depend on to make
decisions in the best interest of the project in a consistent manner. The current
maintainers are listed in the [MAINTAINERS](./MAINTAINERS) file. The maintainers role
can be a top-level or restricted to certain package/feature depending upon their
commitment in fulfilling the expected responsibilities as explained below.

### Top-level maintainer

- Running the etcd release processes
- Ownership of test and debug infrastructure
- Triage GitHub issues to keep the issue count low (goal: under 100)
- Regularly review GitHub pull requests across all pkgs
- Providing cross pkg design review
- Monitor email aliases
- Participate when called upon in the [security disclosure and release process](security/README.md)
- General project maintenance

### Package/feature maintainer

- Ownership of test and debug failures in a pkg/feature
- Resolution of bugs triaged to a package/feature
- Regularly review pull requests to the pkg subsystem

Contributors who are interested in becoming a maintainer, if performing these
responsibilities, should discuss their interest with the existing maintainers. New
maintainers must be nominated by an existing maintainer and must be elected by a
supermajority of maintainers. Likewise, maintainers can be removed by a supermajority
of the maintainers and moved to emeritus status.

Life priorities, interests, and passions can change. If a maintainer needs to step
down, inform other maintainers about this intention, and if possible, help find someone
to pick up the related work. At the very least, ensure the related work can be continued.
Afterward, create a pull request to remove yourself from the [MAINTAINERS](./MAINTAINERS)
file.

## Approvers

Approvers are contributors with merge rights. They are active reviewers and have
created significant numbers of PRs in the various code areas to add new features,
fix bugs and improve code. New approvers must be nominated by an existing maintainer
and must be elected by a supermajority of maintainers. Likewise, approvers can be
removed by a supermajority of the maintainers or can resign by notifying the
maintainers.

## Reviewers

Reviewers are contributors who have demonstrated greater skill in reviewing the code
contribution from other contributors. Their LGTM counts towards merging a code change
into the project. New reviewers must be nominated by an existing maintainer and must
be elected by a supermajority of maintainers. Likewise, reviewers can be removed by a
supermajority of the maintainers or can resign by notifying the maintainers.

## Decision making process

Decisions are built on consensus between maintainers publicly. Proposals and ideas
can either be submitted for agreement via a GitHub issue or PR, or by sending an email
to `[email protected]`.

## Conflict resolution

In general, we prefer that technical issues and maintainer membership are amicably
worked out between the persons involved. However, any technical dispute that has
reached an impasse with a subset of the community, any contributor may open a GitHub
issue or PR or send an email to `[email protected]`. If the
maintainers themselves cannot decide an issue, the issue will be resolved by a
supermajority of the maintainers.

## Changes in Governance

Changes in project governance could be initiated by opening a GitHub PR.
11 changes: 10 additions & 1 deletion MAINTAINERS
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# This is the official list of etcd maintainers.
# The official list of maintainers, approvers, and reviewers for the project maintenance.
#
# Refer to the GOVERNANCE.md for description of the roles.
#
# Names should be added to this file like so:
# Individual's name <submission email address> (@GITHUB_HANDLE) pkg:*
# Individual's name <submission email address> <email2> <emailN> (@GITHUB_HANDLE) pkg:*
#
# Please keep the list sorted.

# MAINTAINERS
Brandon Philips <[email protected]> (@philips) pkg:*
Gyuho Lee <[email protected]> <[email protected]> (@gyuho) pkg:*
Hitoshi Mitake <[email protected]> (@mitake) pkg:*
Expand All @@ -18,3 +21,9 @@ Xiang Li <[email protected]> (@xiang90) pkg:*
Ben Darnell <[email protected]> (@bdarnell) pkg:go.etcd.io/etcd/raft
Tobias Grieger <[email protected]> (@tbg) pkg:go.etcd.io/etcd/raft

# APPROVERS
Anthony Romano <[email protected]> (@heyitsanthony) pkg:*
Fanmin Shi <[email protected]> (@fanminshi) pkg:*

# REVIEWERS
Wenjia Zhang <[email protected]> (@wenjiaswe) pkg:*
16 changes: 0 additions & 16 deletions MAINTAINERS_RULES.md

This file was deleted.

20 changes: 0 additions & 20 deletions OWNERS

This file was deleted.

0 comments on commit 2a266c7

Please sign in to comment.