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

docs: update contributing guidelines for required org membership #2548

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+5 −0
Open

docs: update contributing guidelines for required org membership #2548

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b0e4066
docs: update contributing guidelines for required org membership
JamieDanielson Nov 25, 2024
122df43
add note about triager role and codeowners file
JamieDanielson Nov 25, 2024
66749ed
remove codeowner requirement, component owner is fine
JamieDanielson Dec 2, 2024
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
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ When two or more approaches must be compared, please write a benchmark in the be
This repository contains many components which are maintained by more than the typical set of JS maintainers and approvers.
Each component in this repository SHOULD have a component owner who is responsible for maintaining it.
The README.md for each component SHOULD contain its owner, but the source of truth for component ownership is in [.github/component_owners.yml](.github/component_owners.yml).
Each component owner SHOULD be listed in CODEOWNERS with the path to the component.
Component owners are generally given authority to make decisions relating to implementation and feature requests for their components,
provided they follow the best practices set out by the maintainers and the [mission, vision and values](https://github.com/open-telemetry/community/blob/main/mission-vision-values.md)
of the OpenTelemetry Project.
Expand All @@ -149,6 +150,9 @@ Maintainers may override the decisions of component owners, but should only do s

### Becoming a Component Owner

To become a component owner, contributors MUST be a member of the OpenTelemetry GitHub organization.
To become a member, follow the steps in the [community guidelines for membership requirements](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#requirements).

To become a component owner, contributors SHOULD demonstrate prior knowledge of the instrumented package or the concepts therein.

Ways do to so may be by providing proof of:
Expand Down Expand Up @@ -177,6 +181,7 @@ If all these conditions are met, aspiring component owners are encouraged to sel
information provided on the issue - either approve or deny the ownership request. If the ownership request has been
approved, the new component owner opens a PR to add themselves to the list of owners ([.github/component_owners.yml](.github/component_owners.yml))
for that package.
@open-telemetry/javascript-maintainers will add the component owner to @open-telemetry/javascript-contrib-triagers and to the CODEOWNERS file.

## Component Lifecycle

Expand Down Expand Up @@ -306,6 +311,7 @@ When instrumentation cannot be included in a target package and there is good re
Note that new instrumentation needs at least two contributors assigned to it as code-owners. It is the responsibility
of the requesting party to reach out and find code-owners for the proposed instrumentation. The instrumentation request
needs to be accepted before any pull requests for the instrumentation can be considered for merging.
Review the guidelines for [Becoming a Component Owner](#becoming-a-component-owner).

Regardless of where instrumentation is hosted, it needs to be discoverable.
The [OpenTelemetry registry](https://opentelemetry.io/registry/) exists to ensure that instrumentation is discoverable.
Expand Down