From 232e2cc8701dca864e9c3cb21e82eadcb6f56146 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Wed, 25 Apr 2018 15:31:40 +0100 Subject: [PATCH 1/2] docs: Outdent Project maintainers section The "Project maintainers" section should be a top level section. Signed-off-by: James O. D. Hunt --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bb4ae9db3..c99066ba0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ * [Reviews](#reviews) * [Examples](#examples) * [Contact](#contact) - * [Project maintainers](#project-maintainers) +* [Project maintainers](#project-maintainers) * [Issue tracking](#issue-tracking) * [Closing issues](#closing-issues) @@ -223,7 +223,7 @@ channels, Slack channels, and mailing lists: * [Mailing lists](http://lists.katacontainers.io/). -### Project maintainers +## Project maintainers The Kata Containers project maintainers are the people accepting or rejecting any PR. They are listed in the `OWNERS` files. There can be one From 5a91576b31d634ad2edc4bef8901eb56282a2b04 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Wed, 25 Apr 2018 15:25:57 +0100 Subject: [PATCH 2/2] docs: Remove mention of OWNERS files from contrib guide The Kata project doesn't use `OWNERS` files so rework the "Project Maintainers" section of the contribution guide to explain who the Approvers are and how the approval process works. Fixes #30. Signed-off-by: James O. D. Hunt --- CONTRIBUTING.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c99066ba0..37030da1d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -226,17 +226,23 @@ channels, Slack channels, and mailing lists: ## Project maintainers The Kata Containers project maintainers are the people accepting or -rejecting any PR. They are listed in the `OWNERS` files. There can be one -`OWNERS` file per directory. +rejecting any PR. Although [anyone can review PRs](#reviews), only the +acknowledgement (or "ack") from an Approver counts towards the approval of a PR. -The `OWNERS` files split maintainership into 2 categories: reviewers and -approvers. All approvers also belong to the reviewers list. There must be at -least one approval from one member of each list for a PR to be merged. +Approvers are listed in GitHub teams, one for each repository. The project +uses the [Pull Approve](https://pullapprove.com) service meaning each +repository contains a top level `.pullapprove.yml` configuration file. This +file lists the GitHub team used for that repository's approvals. -Since approvers are also reviewers, they technically can approve a PR without -getting another reviewer's approval. However, it is their due diligence to -rely on reviewers and should use their approval power only in very specific -cases. +Each repository can have custom review requirements but the minimum approval +requirements are: + +- Two approvals from the approval team listed in the configuration file. + +- One [documentation team](https://github.com/orgs/kata-containers/teams/documentation/members) + approval if the PR modifies documentation. + +See the `.pullapprove.yml` configuration files for full details. ## Issue tracking