From 7ff508fe36bad5f4bde2e152a851af436ba43ef1 Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Wed, 27 Dec 2017 00:47:21 +0000 Subject: [PATCH] add a governance policy and expand MAINTAINERS.md --- GOVERNANCE.md | 95 ++++++++++++++++++++++++++++++++++++++++++++++++++ MAINTAINERS.md | 28 ++++++++++----- 2 files changed, 115 insertions(+), 8 deletions(-) create mode 100644 GOVERNANCE.md diff --git a/GOVERNANCE.md b/GOVERNANCE.md new file mode 100644 index 000000000..a6e76e557 --- /dev/null +++ b/GOVERNANCE.md @@ -0,0 +1,95 @@ +# Project governance + +The tldr-pages project strives to have an **open**, **welcoming**, +and [**non-hierarchical**](https://en.wikipedia.org/wiki/Flat_organization) +governance structure. + +To that end, this document describes the principles +that guide the self-management of the project. +By having them written down explicitly, and open to scrutiny, +the entire community can read, improve and adapt them as needed, +with no central authority. + + +## I. Participation and community interactions + +- **All contributions are welcome**, + [no matter how small](https://github.com/kentcdodds/all-contributors). + The tldr-pages project is a [do-ocracy](https://communitywiki.org/wiki/DoOcracy), + so don't hesitate to get involved — we're happy to welcome you into the community! + Please take a look at [CONTRIBUTING.md](https://github.com/tldr-pages/tldr/blob/master/CONTRIBUTING.md) + to get started. + +- All members of the community are expected to **be cordial in all communications**. + Avoid making assumptions about the others' intentions, and make your own intentions clear. + When in doubt, provide additional context, or ask for clarification. + Remember, it's very hard to convey meaning on a purely written medium, + especially between people from different cultures, technical backgrounds, + English proficiency levels, etc. + +- **All communications are public**. + There are no permanent private channels where maintainers discuss "internal" matters. + Occasional private chat messages may be exchanged, + e.g. when setting up services that require passwords, + but otherwise all exchanges that impact the project either happen in issue or PR discussions, + or in the [Gitter chat room](https://gitter.im/tldr-pages/tldr) + (which is open to all, and publicly logged). + +- **All decisions are made by community consensus.** + This does not mean there has to be unanimity, + nor that decisions result from vote counts. + What it means is that every interested member of the community can voice their thoughts, + and different positions are ideally resolved via + [informed consent](https://en.wikipedia.org/wiki/Sociocracy#Consent_vs._consensus) + of the involved people, who accept the collective decision + as "good enough for now, safe enough to try". + + +## II. Role transitions + +The main goal of these principles is to support a continuous replenishing of the management team +via a **smooth transition flow between community roles** — +from newcomer, to occasional contributor, to regular contributor, to maintainer. +This way the project can adapt in a flexible way +to the the natural variations in availability and interest of its contributors, +ensuring long-term resilience, +and avoiding [single points of failure](https://en.wikipedia.org/wiki/Bus_factor). + +To this end, rather than assigning roles and tasks to people, +these guidelines instead aim to **recognize the work that people already do**. +Everyone is therefore encouraged to get involved and contribute to the project in whatever way they prefer, +and we will strive to **get barriers out of the way** of these contributions. + +To ensure that these processes are transparent, predictable, and free from subective judgment, +the metrics used are simple, objective, and publicly available. + +- Regular contributors shall be recognized as collaborators in the organization. + + - Specifically: once a contributor has had **5 pull requests merged**, + they should be invited to become a + [**member of the tldr-pages organization**](https://github.com/orgs/tldr-pages/people). + This means they will be able to push commits to all of the organization's repositories, + merge PRs, label and close issues, among other things. + Note: All members of the tldr-pages organization must make their membership public. + +- Members of the organization who demonstrate interest in performing maintainership tasks, + by reviewing and/or merging PRs, responding to and labeling issues, and generally doing project maintenance work, + shall be made part of the maintenance team, and their name added to the list of current maintainers + in the [MAINTAINERS.md](MAINTAINERS.md) file. + + - Specifically: once a contributor has been an organization member for at least 3 months, + and has **reviewed or merged 10 pull requests** by other contributors, + they should be invited to become an **owner of the tldr-pages organization**. + This means they will be able to add people to the organization, + manage all the organization's repositories, configure integrations, etc. + +- If a collaborator or maintainer stops being active in the project for more than 6 months, + their membership status will be equally deactivated, + and their name added to the list of former maintainers in the MAINTAINERS.md file. + Again, this is and merely a reflection of their actual involvement with the project, + not a demotion or punishment. In fact, if they return to active participation in the project, + they should be re-added back to the organization, to reflect that fact. + + - This inactivity threshold additionally ensures + that the list of organization members doesn't grow to unwieldy sizes, + and that it accurately reflects the active team managing the project. diff --git a/MAINTAINERS.md b/MAINTAINERS.md index c3b2f2e62..a6e10e08c 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1,8 +1,20 @@ -Romain Prieto (@rprieto) -Igor Shubovych (@igorshubovych) -Ruben Vereecken (@rubenvereecken) -Waldir Pimenta (@waldyrious) -Felix Yan (@felixonmars) -Leandro Ostera (@ostera) -Agniva De Sarker (@agnivade) -Starbeamrainbowlabs (@sbrl) +## Current maintainers + +The following people are the current owners of the tldr-pages organization, +and have admin access to all of its repositories. + +- Romain Prieto `` (@rprieto) +- Igor Shubovych `` (@igorshubovych) +- Ruben Vereecken `` (@rubenvereecken) +- Waldir Pimenta `` (@waldyrious) +- Felix Yan `` (@felixonmars) +- Leandro Ostera `` (@ostera) +- Agniva De Sarker `` (@agnivade) +- Starbeamrainbowlabs `` (@sbrl) + +## Past maintainers + +The following people are former maintainers of the tldr-pages project, +who have moved on to other projects. +Their contributions and dedication have ensured the success of the tldr project, +and for that they'll always be appreciated.