Add guidance for maintainers about GitHub issue reactions #2778
Conversation
danielgblanco
requested review from
alolita,
austinlparker,
jpkrohling,
mtwo,
mx-psi,
svrnm,
tedsuo and
trask
as code owners
There was a problem hiding this comment.
Looks good to me! Thanks for all the effort around this @danielgblanco! 😁
|
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. |
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.
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.
big +1, this is also a way to make people aware of it AND giving them an opportunity to subscribe to this (or not) |
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:
|
|
@open-telemetry/sig-contributor-experience-approvers please take a look as well, since this sits between end users and contributors (and their experience). This may also require some input into a "maintainer guide" and how to handle these most popular issues. |
danielgblanco
force-pushed
the
add_guidance_reactions
branch
from
60c60b7 to
e809908
Compare
## Changes As part of open-telemetry/sig-end-user#11, this adds a subscript paragraph to all issue templates to help end-users and other community members to interact with issues. This change is accompanied by the changes in the maintainer guide proposed in open-telemetry/community#2778, and the changes to the website in open-telemetry/opentelemetry.io#7088 giving users more information about issue participation I propose we trial this in the spec repo and see if it's useful for end-users and for us. --------- Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
#### Description As part of open-telemetry/sig-end-user#11, this adds a subscript paragraph to all issue templates to help end-users and other community members interact with issues. This change is accompanied by the changes in the maintainer guide proposed in open-telemetry/community#2778, and the changes to the website in open-telemetry/opentelemetry.io#7088 giving users more information about issue participation The major caveat of this PR is the necessity of using the `dropdown` element in issue forms. As covered in this [feedback discussion topic](https://github.com/orgs/community/discussions/63402#discussioncomment-10341167), it is not possible to create `markdown` elements that render on the resulting issue body. As such, the only possibilities are a checkbox, a dropdown, or some form of pre-filled input text that would be even more confusing. Working version can be seen in danielgblanco#6 with the issue form being rendered as https://github.com/danielgblanco/opentelemetry-collector-contrib/issues/new?template=bug_report.yaml I'm leaving this as draft for now, until the changes to the website have been merged and we the link to guidance is active.
#### Description As part of open-telemetry/sig-end-user#11, this adds a subscript paragraph to all issue templates to help end-users and other community members interact with issues. This change is accompanied by the changes in the maintainer guide proposed in open-telemetry/community#2778, and the changes to the website in open-telemetry/opentelemetry.io#7088 giving users more information about issue participation The major caveat of this PR is the necessity of using the `dropdown` element in issue forms. As covered in this [feedback discussion topic](https://github.com/orgs/community/discussions/63402#discussioncomment-10341167), it is not possible to create `markdown` elements that render on the resulting issue body. As such, the only possibilities are a checkbox, a dropdown, or some form of pre-filled input text that would be even more confusing. Working version can be seen in danielgblanco/opentelemetry-collector-contrib#6 with the issue form being rendered as https://github.com/danielgblanco/opentelemetry-collector-contrib/issues/new?template=bug_report.yaml
Co-authored-by: trask <218610+trask@users.noreply.github.com>
#### Description As part of open-telemetry/sig-end-user#11, this adds a subscript paragraph to all issue templates to help end-users and other community members interact with issues. This change is accompanied by the changes in the maintainer guide proposed in open-telemetry/community#2778, and the changes to the website in open-telemetry/opentelemetry.io#7088 giving users more information about issue participation The major caveat of this PR is the necessity of using the `dropdown` element in issue forms. As covered in this [feedback discussion topic](https://github.com/orgs/community/discussions/63402#discussioncomment-10341167), it is not possible to create `markdown` elements that render on the resulting issue body. As such, the only possibilities are a checkbox, a dropdown, or some form of pre-filled input text that would be even more confusing. Working version can be seen in danielgblanco#6 with the issue form being rendered as https://github.com/danielgblanco/opentelemetry-collector-contrib/issues/new?template=bug_report.yaml I'm leaving this as draft for now, until the changes to the website have been merged and we the link to guidance is active.
9 participants
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.