Skip to content

Add subscript to issue templates #13193

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 4 commits into
base: main
Choose a base branch
from

Conversation

danielgblanco
Copy link

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, 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

@danielgblanco danielgblanco requested a review from a team as a code owner June 11, 2025 19:18
@danielgblanco danielgblanco marked this pull request as draft June 11, 2025 19:18
@danielgblanco
Copy link
Author

Sorry, should've created this as draft. I think it's better to wait for the message to be merged in the website, so that the link is not a dead link and we can explain issue prioritisation.

Copy link

codecov bot commented Jun 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.55%. Comparing base (3ef58fd) to head (1693cc1).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #13193      +/-   ##
==========================================
- Coverage   91.56%   91.55%   -0.02%     
==========================================
  Files         520      520              
  Lines       28918    28918              
==========================================
- Hits        26479    26475       -4     
- Misses       1923     1926       +3     
- Partials      516      517       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@danielgblanco danielgblanco changed the title Add subheading Add subscript to issue templates Jun 11, 2025
@mx-psi mx-psi added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jun 12, 2025
@danielgblanco danielgblanco marked this pull request as ready for review June 16, 2025 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants