|
| 1 | +# Managing Popular GitHub Issues |
| 2 | + |
| 3 | +Within OpenTelemetry, we encourage end-users and community members to leave 👍 |
| 4 | +reactions on GitHub issues they'd like to be worked on, as indicated in our |
| 5 | +[website](https://opentelemetry.io/community). This can help maintainers to: |
| 6 | + |
| 7 | +- Get a high-level signal that measures the interest from the community in |
| 8 | + particular issues, in a way that can be evaluated and compared across one or |
| 9 | + many repositories. |
| 10 | +- Avoid redundant, unproductive comments like _"I have this issue too"_, which |
| 11 | + are difficult to compare across issues, and provide no context for triage. |
| 12 | + |
| 13 | +In addition to these benefits, this standardized approach helps the wider |
| 14 | +OpenTelemetry community by making it easier for end-users to highlight important |
| 15 | +issues without requiring them to join SIG meetings or Slack channels. This also |
| 16 | +allows the End-User SIG to focus on specific topics that demonstrate how user |
| 17 | +input shapes OpenTelemetry, boosting engagement and strengthening the feedback |
| 18 | +loop. |
| 19 | + |
| 20 | +## Popularity Does Not Imply Priority |
| 21 | + |
| 22 | +OpenTelemetry SIGs have the autonomy to organize their work and manage roadmaps |
| 23 | +independently, balancing their priorities while remaining aligned with the |
| 24 | +general direction of the project. |
| 25 | + |
| 26 | +While maintainers may use these reactions to prioritize issues, they’re **not |
| 27 | +expected to solely base their issue prioritization on popularity**. Cases where |
| 28 | +popular issues are not prioritized include (but are not limited to): |
| 29 | + |
| 30 | +* High-priority SIG work (e.g. security, spec compliance). |
| 31 | +* Issues that require other work to be completed before they can be addressed. |
| 32 | +* Requests or proposals not aligning with the direction of the project. |
| 33 | + |
| 34 | +## Communicating Priorities |
| 35 | + |
| 36 | +Triagers should keep the most voted issues up-to-date on a best-effort basis, |
| 37 | +and communicate SIG priorities back to users if other work is taking precedence |
| 38 | +before a given issue is prioritized. This avoids frustration for end-users and |
| 39 | +gives them a way to see progress towards the issues they find the most |
| 40 | +important. |
| 41 | + |
| 42 | +How this communication is carried out within the most voted issues, or how many |
| 43 | +issues are considered, is decided by SIG maintainers and triagers. This may |
| 44 | +involve pointing users to a project board where issues are prioritized, meeting |
| 45 | +notes, or simply updating popular issues regularly. |
| 46 | + |
| 47 | +## Finding the Most Popular Issues |
| 48 | + |
| 49 | +The most popular issues for a given SIG can be found: |
| 50 | + |
| 51 | +- For a particular repo: see |
| 52 | + [this sample filter](https://github.com/open-telemetry/community/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc) |
| 53 | + for the `community` repo. |
| 54 | +- Across multiple repos: see |
| 55 | + [this sample filter](https://github.com/search?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+repo%3Aopen-telemetry%2Fopentelemetry.io+repo%3Aopen-telemetry%2Fcommunity+&type=issues) |
| 56 | + for the `community` and `opentelemetry.io` repos. |
| 57 | + |
| 58 | +## Recommended Footnote on Issue Templates |
| 59 | + |
| 60 | +We recommend using the following footnote on issue templates to ensure users |
| 61 | +have direct access to guidance on how OpenTelemetry uses issue reactions. |
| 62 | + |
| 63 | +### Markdown Templates |
| 64 | + |
| 65 | +Add this to the bottom of the `.md` file. |
| 66 | + |
| 67 | +```markdown |
| 68 | +<sub>**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/).</sub> |
| 69 | +``` |
| 70 | + |
| 71 | +Which renders as: |
| 72 | + |
| 73 | +<sub>**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/).</sub> |
| 74 | + |
| 75 | +### Issue Forms |
| 76 | + |
| 77 | +As covered in this |
| 78 | +[feedback discussion topic](https://github.com/orgs/community/discussions/63402#discussioncomment-10341167), |
| 79 | +it is not possible to create `markdown` elements that render on the resulting |
| 80 | +issue body. As such, we recommend using a dropdown element with a default |
| 81 | +option. |
| 82 | + |
| 83 | +```yaml |
| 84 | + - type: dropdown |
| 85 | + attributes: |
| 86 | + label: Tip |
| 87 | + description: This element is static, used to render a helpful sub-heading for end-users and community members to help prioritize issues. Please leave as is. |
| 88 | + options: |
| 89 | + - <sub>[React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/).</sub> |
| 90 | + default: 0 |
| 91 | +``` |
| 92 | +
|
| 93 | +In the issue form, this renders as: |
| 94 | +
|
| 95 | + |
| 96 | +
|
| 97 | +In the resulting issue, this renders as: |
| 98 | +
|
| 99 | +### Tip |
| 100 | +
|
| 101 | +<sub>[React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/)with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/).</sub> |
0 commit comments