From 7a14926f36b3bd1d0f4eead286efd6df50a245f9 Mon Sep 17 00:00:00 2001 From: Reiley Yang Date: Tue, 1 Oct 2019 21:11:49 -0700 Subject: [PATCH 1/4] update contrib doc --- CONTRIBUTING.md | 34 +++++++++------------------------- 1 file changed, 9 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1512dfe702..4ce9126ec9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,11 @@ See the [public meeting notes](https://docs.google.com/document/d/1CIMGoIOZ-c3-i for a summary description of past meetings. To request edit access, join the meeting or get in touch on [Gitter](https://gitter.im/open-telemetry/opentelemetry-python). +Please refer to the [Community Membership](https://github.com/open-telemetry/community/blob/master/community-membership.md) +document on how to become a [Member](https://github.com/open-telemetry/community/blob/master/community-membership.md#member), +[Approver](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver) +and [Maintainer](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer). + ## Development This project uses [`tox`](https://tox.readthedocs.io) to automate some aspects @@ -74,15 +79,16 @@ Open a pull request against the main `opentelemetry-python` repo. ### How to Get PRs Merged A PR is considered to be **ready to merge** when: -* It has received two approvals from Collaborators/Maintainers (at different - companies). +* It has received two approvals from [Approvers]((https://github.com/open-telemetry/community/blob/master/community-membership.md#approver)) + / [Maintainers](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer) + (at different companies). * Major feedbacks are resolved. * It has been open for review for at least one working day. This gives people reasonable time to review. * Trivial change (typo, cosmetic, doc, etc.) doesn't have to wait for one day. * Urgent fix can take exception as long as it has been actively communicated. -Any Collaborator/Maintainer can merge the PR once it is **ready to merge**. +Any Approver/Maintainer can merge the PR once it is **ready to merge**. ## Design Choices @@ -111,25 +117,3 @@ For a deeper discussion, see: https://github.com/open-telemetry/opentelemetry-sp as specified with the [napolean extension](http://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html#google-vs-numpy) extension in [Sphinx](http://www.sphinx-doc.org/en/master/index.html). - -## Become a Collaborator - -Collaborators have write access to the repo. - -To become a Collaborator: -* Become an active Contributor by working on PRs. -* Actively participate in the community meeting, design discussion, PR review - and issue discussion. -* Contact the Maintainers, express the willingness and commitment. -* Acknowledged and approved by two Maintainers (at different companies). - -## Become a Maintainer - -Maintainers have admin access to the repo. - -To become a Maintainer: -* Become a [member of OpenTelemetry organization](https://github.com/orgs/open-telemetry/people). -* Become a Collaborator. -* Demonstrate the ability and commitment. -* Contact the Maintainers, express the willingness and commitment. -* Acknowledged and approved by all the current Maintainers. From 8c3fad5b274963f1f851cca5664c4af132429ae3 Mon Sep 17 00:00:00 2001 From: Reiley Yang Date: Tue, 1 Oct 2019 21:13:40 -0700 Subject: [PATCH 2/4] style change --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ce9126ec9..e7477bc7b3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,10 +8,10 @@ See the [public meeting notes](https://docs.google.com/document/d/1CIMGoIOZ-c3-i for a summary description of past meetings. To request edit access, join the meeting or get in touch on [Gitter](https://gitter.im/open-telemetry/opentelemetry-python). -Please refer to the [Community Membership](https://github.com/open-telemetry/community/blob/master/community-membership.md) -document on how to become a [Member](https://github.com/open-telemetry/community/blob/master/community-membership.md#member), -[Approver](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver) -and [Maintainer](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer). +See to the [community membership document](https://github.com/open-telemetry/community/blob/master/community-membership.md) +on how to become a [**Member**](https://github.com/open-telemetry/community/blob/master/community-membership.md#member), +[**Approver**](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver) +and [**Maintainer**](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer). ## Development From 3d490252a43d5942f80e7aa5418827b0f53e996f Mon Sep 17 00:00:00 2001 From: Reiley Yang Date: Tue, 1 Oct 2019 21:17:08 -0700 Subject: [PATCH 3/4] fix typo --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e7477bc7b3..bc0079f227 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,7 +79,7 @@ Open a pull request against the main `opentelemetry-python` repo. ### How to Get PRs Merged A PR is considered to be **ready to merge** when: -* It has received two approvals from [Approvers]((https://github.com/open-telemetry/community/blob/master/community-membership.md#approver)) +* It has received two approvals from [Approvers](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver) / [Maintainers](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer) (at different companies). * Major feedbacks are resolved. From 528fe55bd36c9f804960862a44c75289bb23e8f7 Mon Sep 17 00:00:00 2001 From: Reiley Yang Date: Tue, 1 Oct 2019 21:18:10 -0700 Subject: [PATCH 4/4] style tweak --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc0079f227..9bb81d7165 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -88,7 +88,7 @@ A PR is considered to be **ready to merge** when: * Trivial change (typo, cosmetic, doc, etc.) doesn't have to wait for one day. * Urgent fix can take exception as long as it has been actively communicated. -Any Approver/Maintainer can merge the PR once it is **ready to merge**. +Any Approver / Maintainer can merge the PR once it is **ready to merge**. ## Design Choices