Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Contributing.md doc #194

Merged
merged 4 commits into from
Oct 2, 2019
Merged

Update Contributing.md doc #194

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7a14926
update contrib doc
reyang Oct 2, 2019
8c3fad5
style change
reyang Oct 2, 2019
3d49025
fix typo
reyang Oct 2, 2019
528fe55
style tweak
reyang Oct 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 9 additions & 25 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

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

This project uses [`tox`](https://tox.readthedocs.io) to automate some aspects
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.