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.

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

[Triage Process] Allow SIG maintainers to express their requirements #4229

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

svrnm
Copy link
Member

@svrnm svrnm commented Sep 26, 2024

Since #3990 is merged now, this fixes #4083

Changes

This introduces what has been discussed in #4083: it adds words to the issue management document to define the maintainer-blocked and maintainer-request labels and the process on how they can be applied by SIG maintainers.

Copy link
Member

@pellared pellared left a comment

Choose a reason for hiding this comment

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

I have a feeling that having a single maintainer-request label could be good enough. The TC can prioritize the issue based on their judgement. Different maintelainers may also have different opinions on what is a blocker and what is not.


A triager will add the requested label to the issue if those conditions are met. The difference between the 2 labels is as follows:

- `maintainer-blocked` means that there is an issue with the specification that blocks the SIG from implementing an existing part of the specification.
Copy link
Member

Choose a reason for hiding this comment

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

What if there is something missing in the specification that blocks the implementation?

Copy link
Member

Choose a reason for hiding this comment

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

I guess we can use bug for things that require fixes. And if maintainers are blocked by things that don't exist yet, those can be tagged as feature. (side note: most GitHub repositories make heavy use of these labels, the fact that OTel spec repo doesn't use it frequently is somewhat odd to me)

A triager will add the requested label to the issue if those conditions are met. The difference between the 2 labels is as follows:

- `maintainer-blocked` means that there is an issue with the specification that blocks the SIG from implementing an existing part of the specification.
- `maintainer-request` means that there is no blocking issue with an existing part of the specification. This means, that the SIG either wants to implement something that is not yet part of the specification, or that they can go forward with the implementation regardless, but want to clarify ambiguity or inaccuracy.
Copy link
Member

Choose a reason for hiding this comment

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

they can go forward with the implementation regardless

This seems very unwanted

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
Contributor

Choose a reason for hiding this comment

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

+1 to what @pellared said. Also, for cases of adding new functionality, there's the OTEP path. Implementation specific doubts (to leave out ambiguity) are fine though, IMHO. But honestly we could use the maintainer-blocked label for that purpose too.

A triager will add the requested label to the issue if those conditions are met. The difference between the 2 labels is as follows:

- `maintainer-blocked` means that there is an issue with the specification that blocks the SIG from implementing an existing part of the specification.
- `maintainer-request` means that there is no blocking issue with an existing part of the specification. This means, that the SIG either wants to implement something that is not yet part of the specification, or that they can go forward with the implementation regardless, but want to clarify ambiguity or inaccuracy.
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't ambiguity be a blocker?

issue-management.md Outdated Show resolved Hide resolved
@svrnm
Copy link
Member Author

svrnm commented Sep 26, 2024

@pellared @reyang thanks for the initial feedback. I tried to distinguish between "blocked" and "requested" to create some kind of "escalation levels" but based on your comments and re-thinking this may not be necessary. I can rewrite it with only one label (maintainer-request ?)

@reyang
Copy link
Member

reyang commented Sep 26, 2024

@pellared @reyang thanks for the initial feedback. I tried to distinguish between "blocked" and "requested" to create some kind of "escalation levels" but based on your comments and re-thinking this may not be necessary. I can rewrite it with only one label (maintainer-request ?)

I don't have strong preference between the two proposals.

When I think about the process, I can see the following cases which we might need to consider:

  1. If an issue is created by someone who is not a maintainer, later a maintainer saw it and said "Oh, that's exactly the issue that I'm facing right now", we need to have a way to tag it (we can also create a new issue and resolve the original one as duplicated, I don't like this approach though).
  2. Issues targeting the "Development" or "Deprecated" part of the spec might have much lower priority than issues against the "Stable" part of the spec.

I understand that defining process is very hard. Nobody likes complicated process, but a big/complex project cannot succeed with clear/good process. THANK YOU for helping us to improve the process/efficiency @svrnm!

@pellared
Copy link
Member

I prefer small incremental changes in processes when these are not totally wrong (and need be rebuild from ground 😉) Thus proposing just one label. It will be easier also for maintainers to use as they won't need to think which label to select.

Copy link

github-actions bot commented Oct 8, 2024

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Oct 8, 2024
@svrnm
Copy link
Member Author

svrnm commented Oct 8, 2024

Will follow up as soon as possible!

@svrnm svrnm removed the Stale label Oct 8, 2024
@svrnm
Copy link
Member Author

svrnm commented Oct 10, 2024

20cef8e addresses the feedback provided:

  • Use only one label and with that the wording how they are different
  • Make it clear that a maintainer can also use comments on an existing issue to express their needs
  • add links to the meetings + cncf slack

Copy link

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Oct 18, 2024
@svrnm
Copy link
Member Author

svrnm commented Oct 18, 2024

Can someone take a look at the recent changes I made?

issue-management.md Outdated Show resolved Hide resolved
Co-authored-by: Reiley Yang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Triage Process] Allow SIG maintainers to express their requirements
5 participants