docs: Add Contributor Expectations document

Collect up all the contributor expectations and PR requirements into a
single place. Add additional guidelines about creating small PRs and how
to break up PRs into multiple commits.

Signed-off-by: Keith Short <keithshort@google.com>
This commit is contained in:
Keith Short 2022-12-01 16:16:34 -07:00 committed by Carles Cufí
commit 34165a3480
4 changed files with 293 additions and 45 deletions

View file

@ -23,6 +23,8 @@ by approval of the existing Collaborators and Maintainers of the
particular code base areas or subsystems.
.. _contributor:
Contributor
+++++++++++
@ -108,7 +110,7 @@ in addition to those listed for Contributors and Collaborators:
of involvement.
* Right to make decisions in the relevant subsystems or areas of involvement,
in conjunction with the collaborators and submitters.
See :ref:`escalation-process`.
See :ref:`pr_technical_escalation`.
* Responsibility to convey the direction of the relevant subsystem or areas to
the TSC
* Responsibility to ensure all contributions of the project have been reviewed
@ -154,7 +156,9 @@ the latter is not possible.
of the code
* Responsibility to drive the pull request to a mergeable state
* Solicit approvals from maintainers of the subsystems affected
* Responsibility to drive the escalation process
* Responsibility to drive the :ref:`pr_technical_escalation` process
.. _release-engineering-team:
Release Engineering Team
++++++++++++++++++++++++
@ -305,6 +309,8 @@ Release Activity
:align: center
:alt: Release Activity
.. _merge_criteria:
Merge Criteria
++++++++++++++
@ -341,27 +347,3 @@ Merge Criteria
* A minimum review period of 2 days, 4 hours for trivial changes (see
:ref:`review_time`). Hotfixes can be merged at any time after CI passes.
* All required checks are passing
.. _escalation-process:
Escalation Process
++++++++++++++++++
* Contributors may object to change requests or decisions made by
Maintainers.
* Process
* Resolve in the PR among assignee, maintainers and reviewer
* Assignee to act as moderator if applicable
* Optionally resolve in the dev review meeting with more Maintainers
and project stakeholders
* The involved parties and the Assignee to be present when
the (escalated) issue is discussed
* TSC: Assignees can escalate to the TSC voting members and get
a binding resolution in the TSC.
* Assignee to ensure the resolution of the escalation is
reflected in the PR review.