Skip to content

Commit 32278ed

Browse files
Add subscript to issue templates (#13193)
#### 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
1 parent c650ec9 commit 32278ed

File tree

5 files changed

+25
-1
lines changed

5 files changed

+25
-1
lines changed

β€Ž.github/ISSUE_TEMPLATE/bug_report.yamlβ€Ž

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,4 +128,10 @@ body:
128128
attributes:
129129
label: Additional context
130130
description: Any additional information you think may be relevant to this issue.
131-
131+
- type: dropdown
132+
attributes:
133+
label: Tip
134+
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.
135+
options:
136+
- <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>
137+
default: 0

β€Ž.github/ISSUE_TEMPLATE/feature_request.yamlβ€Ž

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,3 +75,10 @@ body:
7575
attributes:
7676
label: Additional context
7777
description: Add any other context or screenshots about the feature request here.
78+
- type: dropdown
79+
attributes:
80+
label: Tip
81+
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.
82+
options:
83+
- <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>
84+
default: 0

β€Ž.github/ISSUE_TEMPLATE/other.yamlβ€Ž

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,10 @@ body:
5959
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
6060
validations:
6161
required: true
62+
- type: dropdown
63+
attributes:
64+
label: Tip
65+
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.
66+
options:
67+
- <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>
68+
default: 0

β€Ž.github/ISSUE_TEMPLATE/stabilization.mdβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,5 @@ Please also make sure to publicly announce our intent to stabilize the module on
2323
To help other people verify the above criteria, please link to the announcement and other links used to complete the above in a comment on this issue.
2424

2525
Once all criteria are met, close this issue by moving this module to the `stable` module set.
26+
27+
<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>

β€Ž.github/ISSUE_TEMPLATE/vote.mdβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,5 @@ For closing the vote:
5959
- [ ] At least one-third of the stakeholders have voted.
6060
- [ ] The "Voting options" and "Result" sections have been updated reflecting the votes casted.
6161
- [ ] The RFC has been updated reflecting the votes casted.
62+
63+
<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>

0 commit comments

Comments
Β (0)