From 0ecaa108c1de8b7a9e45b9d47e193949b9ab559e Mon Sep 17 00:00:00 2001 From: Richard Hartmann Date: Tue, 16 Jun 2020 19:21:59 +0200 Subject: [PATCH] [WIP] Propose new governance (#2137) Add new governance Signed-off-by: Richard Hartmann Co-authored-by: Cyril Tovena --- MAINTAINERS.md | 1 + docs/community/governance.md | 142 +++++++++++++++++++++++------------ 2 files changed, 93 insertions(+), 50 deletions(-) create mode 100644 MAINTAINERS.md diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 000000000000..e7037e809519 --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1 @@ +@slim-bean is the main/default maintainer. diff --git a/docs/community/governance.md b/docs/community/governance.md index efc90e939eb4..f6782ce11998 100644 --- a/docs/community/governance.md +++ b/docs/community/governance.md @@ -1,77 +1,86 @@ -# Loki's Governance Model +# Governance -This document describes the rules and governance of the Loki project. It is meant to be followed by all the developers of the project and the community. +This document describes the rules and governance of the project. It is meant to be followed by all the developers of the project and the Loki community. Common terminology used in this governance document are listed below: + +* **Team members**: Any members of the private [team mailing list][team]. + +* **Maintainers**: Maintainers lead an individual project or parts thereof ([`MAINTAINERS.md`][maintainers]). + +* **Projects**: A single repository in the Grafana GitHub organization and listed below is referred to as a project: + * loki + * puppet-promtail + +* **The Loki project**: The sum of all activities performed under this governance, concerning one or more repositories or the community. ## Values -The Loki [team](#team-members) and community are expected to follow the values defined in the [Loki Code of Conduct](https://github.com/grafana/loki/blob/master/CODE_OF_CONDUCT.md). Furthermore, the Loki community strives for kindness, giving feedback effectively, and building a welcoming environment. The Loki developers generally decide by lazy consensus and only resort to conflict resolution by a majority vote if consensus cannot be reached. +The Loki developers and community are expected to follow the values defined in the [Code of Conduct][coc]. Furthermore, the Loki community strives for kindness, giving feedback effectively, and building a welcoming environment. The Loki developers generally decide by consensus and only resort to conflict resolution by a majority vote if consensus cannot be reached. -## New contributors +## Projects -New contributors should be welcomed to the community by existing members, helped with PR workflow, and directed to relevant documentation and communication channels. +Each project must have a [`MAINTAINERS.md`][maintainers] file with at least one maintainer. Where a project has a release process, access and documentation should be such that more than one person can perform a release. Releases should be announced on the [announcemount][announce] and [users][users] mailing lists. Any new projects should be first proposed on the [team mailing list][team] following the voting procedures listed below. ## Decision making ### Team members -Team member status may be given to those who have made ongoing contributions to the Loki project for at least 3 months. This is usually in the form of code improvements and/or notable work on documentation, but organizing events or user support would also be taken into account. +Team member status may be given to those who have made ongoing contributions to the Loki project for at least 3 months. This is usually in the form of code improvements and/or notable work on documentation, but organizing events or user support could also be taken into account. -Established 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. +New members may be proposed by any existing member by email to the [team mailing list][team]. It is highly desirable to reach consensus about acceptance of a new member. However, the proposal is ultimately voted on by a formal [supermajority vote](#supermajority-vote). -The current team members are: +If the new member proposal is accepted, the proposed team member should be contacted privately via email to confirm or deny their acceptance of team membership. This email will also be CC'd to the [team mailing list][team] for record-keeping purposes. -- Aditya C S [adityacs](https://github.com/adityacs) -- Cyril Tovena (Grafana Labs) [cyriltovena](https://github.com/cyriltovena) -- David Kaltschmidt (Grafana Labs) [davkal](https://github.com/davkal) -- Edward Welch (Grafana Labs) [slim-bean](https://github.com/slim-bean) -- Goutham Veeramachaneni (Grafana Labs) [gouthamve](https://github.com/gouthamve) -- Joe Elliott (Grafana Labs) [joe-elliott](https://github.com/joe-elliott) -- Owen Diehl (Grafana Labs) [owen-d](https://github.com/owen-d) -- Robert Fratto (Grafana Labs) [rfratto](https://github.com/rfratto) -- Sandeep Sukhani (Grafana Labs) [sandeepsukhani](https://github.com/sandeepsukhani) -- Tom Braack (Grafana Labs) [sh0rez](https://github.com/sh0rez) -- Tom Wilkie (Grafana Labs) [tomwilkie](https://github.com/tomwilkie) +If they choose to accept, the [onboarding](#onboarding) procedure is followed. -### Responsibilities and privileges +Team members may retire at any time by emailing [the team][team]. -- 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 in a timely manner -- Assigned PRs to review related based on expertise -- Granted commit access to Loki repository +Team members can be removed by [supermajority vote](#supermajority-vote) on [the team mailing list][team]. +For this vote, the member in question is not eligible to vote and does not count towards the quorum. +Any removal vote can cover only one single person. -### New members +Upon death of a member, they leave the team automatically. -New members may be proposed by any existing member by email to loki-team@googlegroups.com. It is highly desirable to reach consensus about acceptance of a new member. However, the proposal is ultimately voted on by a formal [supermajority vote](#supermajority-vote). +In case a member leaves, the [offboarding](#offboarding) procedure is applied. -If the new member proposal is accepted, the proposed team member should be contacted privately via email to confirm or deny their acceptance of team membership. This email will also be CC'd to loki-team@googlegroups.com for record-keeping purposes. +The current team members are: + +- Aditya C S - [adityacs](https://github.com/adityacs) +- Cyril Tovena - [cyriltovena](https://github.com/cyriltovena) ([Grafana Labs](https://grafana.com/)) +- David Kaltschmidt - [davkal](https://github.com/davkal) ([Grafana Labs](https://grafana.com/)) +- Edward Welch - [slim-bean](https://github.com/slim-bean) ([Grafana Labs](https://grafana.com/)) +- Goutham Veeramachaneni - [gouthamve](https://github.com/gouthamve) ([Grafana Labs](https://grafana.com/)) +- Joe Elliott - [joe-elliott](https://github.com/joe-elliott) ([Grafana Labs](https://grafana.com/)) +- Owen Diehl - [owen-d](https://github.com/owen-d) ([Grafana Labs](https://grafana.com/)) +- Robert Fratto - [rfratto](https://github.com/rfratto) ([Grafana Labs](https://grafana.com/)) +- Sandeep Sukhani - [sandeepsukhani](https://github.com/sandeepsukhani) ([Grafana Labs](https://grafana.com/)) +- Tom Braack - [sh0rez](https://github.com/sh0rez) ([Grafana Labs](https://grafana.com/)) +- Tom Wilkie - [tomwilkie](https://github.com/tomwilkie) ([Grafana Labs](https://grafana.com/)) + +### Maintainers -If they choose to accept, the following steps are taken: +Maintainers lead one or more project(s) or parts thereof and serve as a point of conflict resolution amongst the contributors to this project. Ideally, maintainers are also team members, but exceptions are possible for suitable maintainers that, for whatever reason, are not yet team members. -- Team members are added to the [GitHub project](https://github.com/grafana/loki) as Collaborator (Push access to the repository). -- **Team member must enable [two-factor authentication](https://help.github.com/articles/about-two-factor-authentication) on their GitHub account** -- Team members are added to the [team mailing list](mailto:loki-team@googlegroups.com). -- Team members are added to the list of team members in this document. -- New team members are announced on the [discussion group](https://groups.google.com/forum/#!forum/lokiproject) and Loki [slack channel](https://grafana.slack.com/messages/CEPJRLQNL) by an existing team member. +Changes in maintainership have to be announced on the [developers mailing list][devs]. They are decided by [rough consensus](#consensus) and formalized by changing the [`MAINTAINERS.md`][maintainers] file of the respective repository. -Team members may retire at any time by emailing the [team](mailto:loki-team@googlegroups.com). +Maintainers are granted commit rights to all projects covered by this governance. -Team members can be removed by [supermajority vote](#supermajority-vote) on the team [mailing list](mailto:loki-team@googlegroups.com). For this vote, the member in question is not eligible to vote and does not count towards the quorum. +A maintainer or committer may resign by notifying the [team mailing list][team]. A maintainer with no project activity for a year is considered to have resigned. Maintainers that wish to resign are encouraged to propose another team member to take over the project. -Upon death of a member, their team membership ends automatically. +A project may have multiple maintainers, as long as the responsibilities are clearly agreed upon between them. This includes coordinating who handles which issues and pull requests. ### Technical decisions -Technical decisions are made informally by the team member, and [lazy consensus](#consensus) is assumed. If no consensus can be reached, the matter may be resolved by [majority vote](#majority-vote). +Technical decisions that only affect a single project are made informally by the maintainer of this project, and [rough consensus](#consensus) is assumed. Technical decisions that span multiple parts of the project should be discussed and made on the [developer mailing list][devs]. + +Decisions are usually made by [rough consensus](#consensus). If no consensus can be reached, the matter may be resolved by [majority vote](#majority-vote). ### Governance changes -Material changes to this document are discussed publicly on as an issue on the Loki repository. Any change requires a [supermajority](#supermajority-vote) in favor. Editorial changes may be made by [lazy consensus](#consensus) unless challenged. +Changes to this document are made by Grafana Labs. ### Other matters -Any matter that needs a decision, including but not limited to financial matters, may be called to a vote by any member if they deem it necessary. For financial, private, or personnel matters, discussion and voting takes place on the [team mailing list](mailto:loki-team@googlegroups.com), otherwise on the public [mailing list](https://groups.google.com/forum/#!forum/lokiproject). +Any matter that needs a decision may be called to a vote by any member if they deem it necessary. For private or personnel matters, discussion and voting takes place on the [team mailing list][team], otherwise on the [developer mailing list][devs]. ## Voting @@ -83,37 +92,70 @@ For all votes, voting must be open for at least one week. The end date should be In all cases, all and only [team members](#team-members) are eligible to vote, with the sole exception of the forced removal of a team member, in which said member is not eligible to vote. -Discussion and votes on personnel matters (including but not limited to team membership and maintainership) are held in private on the [team mailing list](mailto:loki-team@googlegroups.com). All other discussion and votes are held in the public [mailing list](https://groups.google.com/forum/#!forum/lokiproject) or [slack](https://grafana.slack.com/messages/CEPJRLQNL). +Discussion and votes on personnel matters (including but not limited to team membership and maintainership) are held in private on the [team mailing list][team]. All other discussion and votes are held in public on the [developer mailing list][devs]. For public discussions, anyone interested is encouraged to participate. Formal power to object or vote is limited to [team members](#team-members). -## Consensus +### Consensus -The default decision making mechanism for the Loki project is [lazy consensus](https://couchdb.apache.org/bylaws.html#lazy). This means that any decision on technical issues is considered supported by the [team](#team-members) as long as nobody objects. +The default decision making mechanism for the Loki project is [rough][rough] consensus. This means that any decision on technical issues is considered supported by the [team][team] as long as nobody objects or the objection has been considered but not necessarily accomodated. -Silence on any consensus decision is implicit agreement and equivalent to explicit agreement. Explicit agreement may be stated at will. Decisions may, but do not need to be called out and put up for decision publicly at any time and by anyone. +Silence on any consensus decision is implicit agreement and equivalent to explicit agreement. Explicit agreement may be stated at will. Decisions may, but do not need to be called out and put up for decision on the [developers mailing list][devs] at any time and by anyone. Consensus decisions can never override or go against the spirit of an earlier explicit vote. -If any [team member](#team-members) raises objections, the team members work together towards a solution that all involved can accept. This solution is again subject to lazy consensus. +If any [team member](#team-members) raises objections, the team members work together towards a solution that all involved can accept. This solution is again subject to rough consensus. In case no consensus can be found, but a decision one way or the other must be made, any [team member](#team-members) may call a formal [majority vote](#majority-vote). -## Majority vote +### Majority vote -Majority votes must be called explicitly in a separate thread on the appropriate mailing list. The subject must be prefixed with [VOTE]. In the body, the call to vote must state the proposal being voted on. It should reference any discussion leading up to this point. +Majority votes must be called explicitly in a separate thread on the appropriate mailing list. The subject must be prefixed with `[VOTE]`. In the body, the call to vote must state the proposal being voted on. It should reference any discussion leading up to this point. Votes may take the form of a single proposal, with the option to vote yes or no, or the form of multiple alternatives. A vote on a single proposal is considered successful if more vote in favor than against. + If there are multiple alternatives, members may vote for one or more alternatives, or vote “no” to object to all alternatives. It is not possible to cast an “abstain” vote. A vote on multiple alternatives is considered decided in favor of one alternative if it has received the most votes in favor, and a vote from more than half of those voting. Should no alternative reach this quorum, another vote on a reduced number of options may be called separately. -## Supermajority vote +### Supermajority vote -Supermajority votes must be called explicitly in a separate thread on the appropriate mailing list. The subject must be prefixed with [VOTE]. In the body, the call to vote must state the proposal being voted on. It should reference any discussion leading up to this point. +Supermajority votes must be called explicitly in a separate thread on the appropriate mailing list. The subject must be prefixed with `[VOTE]`. In the body, the call to vote must state the proposal being voted on. It should reference any discussion leading up to this point. Votes may take the form of a single proposal, with the option to vote yes or no, or the form of multiple alternatives. A vote on a single proposal is considered successful if at least two thirds of those eligible to vote vote in favor. If there are multiple alternatives, members may vote for one or more alternatives, or vote “no” to object to all alternatives. A vote on multiple alternatives is considered decided in favor of one alternative if it has received the most votes in favor, and a vote from at least two thirds of those eligible to vote. Should no alternative reach this quorum, another vote on a reduced number of options may be called separately. + +## On- / Offboarding + +### Onboarding + +The new member is + +* added to the list of [team members](#team-members). Ideally by sending a PR of their own, at least approving said PR. +* announced on the [developers mailing list][devs] by an existing team member. Ideally, the new member replies in this thread, acknowledging team membership. +* added to the projects with commit rights. +* added to the [team mailing list][team]. + + +### Offboarding + +The ex-member is + +* removed from the list of [team members](#team-members). Ideally by sending a PR of their own, at least approving said PR. In case of forced removal, no approval is needed. +* removed from the projects. Optionally, they can retain maintainership of one or more repositories if the [team](#team-members) agrees. +* removed from the team mailing list and demoted to a normal member of the other mailing lists. +* not allowed to call themselves an active team member any more, nor allowed to imply this to be the case. +* added to a list of previous members if they so choose. + +If needed, we reserve the right to publicly announce removal. + +[announce]: https://groups.google.com/forum/#!forum/loki-announce +[coc]: https://github.com/grafana/loki/blob/master/CODE_OF_CONDUCT.md +[devs]: https://groups.google.com/forum/#!forum/loki-developers +[maintainers]: https://github.com/grafana/loki/blob/master/MAINTAINERS.md +[rough]: https://tools.ietf.org/html/rfc7282 +[team]: https://groups.google.com/forum/#!forum/loki-team +[users]: https://groups.google.com/forum/#!forum/loki-users