Skip to content

Conversation

@reyang
Copy link
Member

@reyang reyang commented Mar 2, 2021

Per discussion during the 03/02/2021 Spec SIG Mtg, I'm sending this PR in hope that all the spec docs would have owners/experts clarified. This could become very useful for semantic convention spec.

@rakyll please review.

@bogdandrutu @jmacd @jsuereth I put your names as the "domain experts" for metrics API spec, please approve if you'd like to be listed in the doc. If I haven't got your approval, I'll assume that you don't want to be listed here so I'll remove your name.

@reyang reyang requested review from a team March 2, 2021 16:56

**Status**: [Experimental](../document-status.md)

**Owner:**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to define what is (not) the responsibility of the Owner, and the Domain Experts.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may also add a few sentences lines when domain experts assigned to a change. Are they always added (1) or are they responsible to handle the disputes (2)? I'd prefer (1).

Copy link
Member Author

@reyang reyang Mar 2, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy to work on a similar PR like #745 after this PR (I think there are several steps - clarify the responsibility, document the process, improve the tooling).
Do you think this is blocking? My thinking is that we need to clarify the ownership anyways, so we don't have to be blocked.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rakyll I vote for (1).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this list be synchronized with metrics approvers https://github.com/open-telemetry/community/blob/01acd5d2c39b764554ac3d87a64a18a09250e9a3/community-members.md#user-content-specifications-and-proto:~:text=Metrics%20Approvers%3A?

My answer would be no, approvers don't necessarily need to own the spec (e.g. if the spec is outdated, the owner should be responsible to fix it, guess this could be a separate clarification PR like #745).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we go with (1), CODEOWNERS as suggested by @tigrannajaryan below would be more automated solution. This led me to think of an approvers list.

I like the idea of explicitly listing owners - it solves an immediate issue. Maybe without overthinking the right approach we can go with just a document header as you suggest and then re-work when needed.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, I think having explicit owners listed here could be the 1st step, once we have all the document with owners clarified, changing it to a different format (e.g. CODEOWNERS file) could be an easy job (and we can enforce that via CI).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to define what is (not) the responsibility of the Owner, and the Domain Experts.

+1 on this.

@tigrannajaryan
Copy link
Member

Should we also add the owner and experts to CODEOWNERS to explicitly assign PRs that touch the area?

Copy link
Member

@SergeyKanzhelev SergeyKanzhelev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it may not be a long term solution, but it may be useful now.

@reyang
Copy link
Member Author

reyang commented Mar 2, 2021

Should we also add the owner and experts to CODEOWNERS to explicitly assign PRs that touch the area?

I think later we can explore the automation (e.g. ensure CODEOWNERS reflect the approvers by adding a simple CI script).


**Status**: [Experimental](../document-status.md)

**Owner:**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to define what is (not) the responsibility of the Owner, and the Domain Experts.

+1 on this.

@SergeyKanzhelev SergeyKanzhelev merged commit 1f8e154 into main Mar 3, 2021
@SergeyKanzhelev SergeyKanzhelev deleted the reyang/ownership branch March 3, 2021 17:51
bogdandrutu pushed a commit that referenced this pull request Mar 4, 2021
ThomsonTan pushed a commit to ThomsonTan/opentelemetry-specification that referenced this pull request Mar 30, 2021
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants