Skip to content

Add guidance for maintainers about GitHub issue reactions #2778

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

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

Conversation

danielgblanco
Copy link
Contributor

As per open-telemetry/sig-end-user#11, this is a first PR adding guidance for maintainers, before adding any guidance for end-users and community members in our website on a separate PR. Our website will then link back to this guidance so that end-users can understand how maintainers use their reactions to GitHub issues (especially important regarding expectations on prioritisation).

For more context see the original proposal.

Copy link
Contributor

@avillela avillela left a comment

Choose a reason for hiding this comment

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

Looks good to me! Thanks for all the effort around this @danielgblanco! 😁


Within OpenTelemetry, we encourage end-users and community members to leave 👍
reactions on GitHub issues, as indicated in our
[website](https://opentelemetry.io/community).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This will need to be updated to the actual page where we elaborate on this, which will be contributed in a future PR

@svrnm
Copy link
Member

svrnm commented May 28, 2025

how are we going to make SIGs aware about this?

@danielgblanco
Copy link
Contributor Author

how are we going to make SIGs aware about this?

I've presented this at the maintainers meeting and shared on the maintainers channel, but I think you're right in that not everyone may be aware of this. One part of this guidance is as much for maintainers as it is for those voting on specific issues, to know that votes don't imply an issue is prioritised.

Regarding keeping the most popular issues up-to-date, do you think this is something that we (GC) can keep an eye on as part of our liaison responsibilities? i.e. every month/quarter look at the top n most voted issues for a SIG and see if there's been any communication?

Regarding issue templates, my intention is to open a PR to each repo adding the footnote mentioned here.

@svrnm
Copy link
Member

svrnm commented May 28, 2025

how are we going to make SIGs aware about this?

I've presented this at the maintainers meeting and shared on the maintainers channel, but I think you're right in that not everyone may be aware of this. One part of this guidance is as much for maintainers as it is for those voting on specific issues, to know that votes don't imply an issue is prioritised.

Yes, that's why I asked, people forget about those things or didn't attend. So I suspect this needs to be circualted across SIGs, e.g. via GC sharing it using their check in channels, or via SIG End User by stopping by at SIGs.

Regarding keeping the most popular issues up-to-date, do you think this is something that we (GC) can keep an eye on as part of our liaison responsibilities? i.e. every month/quarter look at the top n most voted issues for a SIG and see if there's been any communication?

I would prefer this to be owned and run by SIG End User, since this is clearly in the domain of the group, so it does not have to fall back on the GC. The GC can help to get the ball rolling, and we can agree on an initial timeline where GC keeps an eye on it and maybe even pushes for it via the liaison relationship, but eventually SIG End User needs to run and own it.

Regarding issue templates, my intention is to open a PR to each repo adding the footnote mentioned here.

big +1, this is also a way to make people aware of it AND giving them an opportunity to subscribe to this (or not)

@danielgblanco
Copy link
Contributor Author

I would prefer this to be owned and run by SIG End User

Yeah, this is a good idea. I think SIG End-User can follow up with SIG maintainers if most voted issues across OTel are not getting attention in a long time. The intention is that we'll do it for completed issues regardless (mentioned in the doc linked above) to drive blog post/OTiP/Q&A. I'm happy with that but cc'ing @open-telemetry/sig-end-user-maintainers here just in case.

@avillela
Copy link
Contributor

I would prefer this to be owned and run by SIG End User

Yeah, this is a good idea. I think SIG End-User can follow up with SIG maintainers if most voted issues across OTel are not getting attention in a long time. The intention is that we'll do it for completed issues regardless (mentioned in the doc linked above) to drive blog post/OTiP/Q&A. I'm happy with that but cc'ing @open-telemetry/sig-end-user-maintainers here just in case.

Agreed! @svrnm @danielgblanco I'm thinking that one way to circulate this message as well is to:

  • Post in the OTel Announcements channel
  • Periodic reminder on OTel socials
  • Write up a blog post

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.

3 participants