Skip to content

Commit e57f3e4

Browse files
authored
docs: update component ownership guidelines and templates (open-telemetry#2641)
1 parent 6b4e532 commit e57f3e4

File tree

3 files changed

+27
-25
lines changed

3 files changed

+27
-25
lines changed
Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,36 @@
11
---
22
name: Instrumentation request
3-
about: Create a report to add support for an instrumentation
3+
about: Create a request to add a new instrumentation
44
labels: instrumentation-request
55
---
66

77
<!--
8-
**NB:** Before opening an instrumentation request against this repo, please read [the contributing guidelines for new instrumentation](../../CONTRIBUTING.md#new-instrumentation).
8+
**NB:** Before opening an instrumentation request against this repo, please read [the contributing guidelines for new instrumentation](../blob/main/CONTRIBUTING.md#new-instrumentation).
99
-->
1010

11-
### Is your instrumentation request related to a problem? Please describe
11+
### Which library do you want to instrument?
1212
<!--
13-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
A clear and concise description of why this library should be instrumented. Ex. I'm always frustrated when [...]
1414
-->
1515

16-
17-
### Is it applicable for Node or Browser or both?
18-
19-
20-
### Do you expect this instrumentation to be commonly used?
21-
22-
Weekly Downloads:
23-
24-
### What version of instrumentation are you interested in using?
25-
26-
Versions:
27-
2816
### Code Owners
2917

3018
<!--
31-
New Instrumentation requests need at least 2 code-owners that will maintain the instrumentation long-term.
19+
New Instrumentations MUST have at least 2 code-owners that will maintain the instrumentation long-term.
20+
Any code-owners listed MUST fulfill all criteria laid out in the checklist below.
3221
-->
3322

3423
- Owner 1
24+
- [ ] I am a [member of the OpenTelemetry Organization](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#member)
25+
- [ ] I have read [CONTRIBUTING.md](../blob/main/CONTRIBUTING.md) and understand the responsibilities of a component owner
26+
- [ ] I agree to follow and uphold the [mission, vision and values](https://github.com/open-telemetry/community/blob/main/mission-vision-values.md) of the OpenTelemetry project
27+
- [ ] I understand that the component may be subject to the [OpenTelemetry Semantic Conventions](https://github.com/open-telemetry/semantic-conventions) and agree to follow the rules set out therein
3528
- Owner 2
29+
<!-- instruct any co-owners to complete the checklist above and comment it on this issue -->
30+
- [ ] Commented on the issue confirming they have fulfilled all criteria for becoming a component owner
31+
<!-- continue listing co-owners if you have more than two -->
3632

3733
### Additional context
3834
<!--
3935
Add any other context or screenshots about the instrumentation request here. Is there a reference you could point for the well-defined lifecycle methods?
4036
-->
41-

.github/ISSUE_TEMPLATE/ownership_request.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ labels: type:ownership-request
55
---
66

77
<!--
8-
**NB:** Before opening a component ownership request against this repo, please read [CONTRIBUTING.md](../../CONTRIBUTING.md#component-ownership) and its subsections first.
8+
**NB:** Before opening a component ownership request against this repo, please read [CONTRIBUTING.md](../blob/main/CONTRIBUTING.md#component-ownership) and its subsections first.
99
-->
1010

1111
### Which component are you requesting ownership of?
@@ -17,7 +17,7 @@ Put a link to the component here.
1717
### Related Work and Qualifications
1818

1919
<!--
20-
List here why you're qualified to take ownership of the component, see [CONTRIBUTING.md](../../CONTRIBUTING.md#becoming-a-component-owner) for details.
20+
List here why you're qualified to take ownership of the component, see [CONTRIBUTING.md](../blob/main/CONTRIBUTING.md#becoming-a-component-owner) for details.
2121
2222
Examples:
2323
- I am working on <related open-source-project> and have deep knowledge of the instrumented package.
@@ -28,7 +28,8 @@ Examples:
2828

2929
### Checklist
3030

31-
- [ ] I have read [CONTRIBUTING.md](../../CONTRIBUTING.md) and understand the responsibilities of a component owner.
31+
- [ ] I am a [member of the OpenTelemetry Organization](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#member)
32+
- [ ] I have read [CONTRIBUTING.md](../blob/main/CONTRIBUTING.md) and understand the responsibilities of a component owner.
3233
- [ ] I agree to follow and uphold the [mission, vision and values](https://github.com/open-telemetry/community/blob/main/mission-vision-values.md) of the OpenTelemetry project
3334
- [ ] I understand that the component I'm requesting ownership of may be subject to the [OpenTelemetry Semantic Conventions](https://github.com/open-telemetry/semantic-conventions) and agree to follow the rules set out therein.
3435

CONTRIBUTING.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,16 +140,18 @@ When two or more approaches must be compared, please write a benchmark in the be
140140
This repository contains many components which are maintained by more than the typical set of JS maintainers and approvers.
141141
Each component in this repository SHOULD have a component owner who is responsible for maintaining it.
142142
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).
143+
143144
Component owners are generally given authority to make decisions relating to implementation and feature requests for their components,
144145
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)
145-
of the OpenTelemetry Project.
146+
of the OpenTelemetry Project. To facilitate independent triage of issues pertaining to the owned component, component owners are assigned
147+
[the Triager role](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#triager).
146148

147149
Component owners MUST do their best to maintain a high level of quality, security, performance, and specification compliance within their components.
148150
Maintainers may override the decisions of component owners, but should only do so when they feel one or more of these traits is compromised.
149151

150152
### Becoming a Component Owner
151153

152-
To become a component owner, contributors MUST be a member of the OpenTelemetry GitHub organization.
154+
To become a component owner, contributors MUST be a [member](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#member) of the OpenTelemetry GitHub organization.
153155
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).
154156

155157
To become a component owner, contributors SHOULD demonstrate prior knowledge of the instrumented package or the concepts therein.
@@ -270,6 +272,7 @@ please ping ([@open-telemetry/javascript-approvers](https://github.com/orgs/open
270272

271273
- Approved by
272274
- at least one component owner if one is defined in [.github/component_owners.yml](.github/component_owners.yml)
275+
- upon approval, the component owner SHOULD apply the `has:owner-approval` label to signal to maintainers that the PR is ready to merge.
273276
- OR one maintainer
274277
- OR at least one approver who is not the approver merging the pull request
275278
- A pull request for small (simple typo, URL, update docs, or grammatical fix) changes may be approved and merged by the same approver
@@ -295,8 +298,11 @@ The size of the OpenTelemetry JavaScript developer community is not large enough
295298
Therefore, to reach our goal, we have the following recommendations for where instrumentation packages should live.
296299

297300
1. Native to the instrumented package
298-
2. A dedicated public repository
299-
3. Here in the opentelemetry-js-contrib repository
301+
2. Close to where maintenance of the instrumented library takes place. For example:
302+
1. in a repository that is part of the organization that maintains the instrumented library
303+
2. in the same repository as the instrumented library
304+
3. A dedicated public repository
305+
4. Here in the opentelemetry-js-contrib repository
300306

301307
If possible, OpenTelemetry instrumentation should be included in the instrumented package.
302308
This will ensure the instrumentation reaches all package users, and is continuously maintained by developers that understand the package.

0 commit comments

Comments
 (0)