Skip to content

Improve issue templates with guidance about reactions and comments #3055

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jul 2, 2025

This PR improves the GitHub issue templates by adding guidance to help users interact more effectively with issues, similar to the changes made in opentelemetry-collector#13193.

Changes Made

Added a "Tip" dropdown section to both issue templates:

  • .github/ISSUE_TEMPLATE/BUG-REPORT.yml
  • .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml

The tip section guides users to:

  • Use reactions (👍) to help prioritize issues instead of adding "+1" comments
  • Provide useful context in comments rather than "me too" responses
  • Learn more about effective issue participation from the OpenTelemetry community guide

Implementation Details

The tip is implemented as a dropdown element that renders as a helpful subtitle in the GitHub issue body, following the same pattern used in the opentelemetry-collector repository. This approach was chosen because GitHub issue forms don't support standalone markdown elements that render in the issue body.

Benefits

  • Reduces noise in issues by discouraging low-value comments like "+1"
  • Helps maintainers triage issues more efficiently through clear prioritization signals
  • Guides community members toward more constructive issue participation
  • Maintains consistency with other OpenTelemetry repositories

Fixes #3054.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copy link

linux-foundation-easycla bot commented Jul 2, 2025

CLA Missing ID CLA Not Signed

Co-authored-by: cijothomas <5232798+cijothomas@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Improve issue templates Improve issue templates with guidance about reactions and comments Jul 2, 2025
@Copilot Copilot AI requested a review from cijothomas July 2, 2025 17:18
Copilot finished work on behalf of cijothomas July 2, 2025 17:18
@@ -50,3 +50,10 @@ body:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: dropdown
Copy link
Member

Choose a reason for hiding this comment

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

@copilot This maybe better as a textarea rather than a dropdown, with the contents pre-filled..

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good suggestion! I've changed both issue templates to use a textarea with pre-filled content instead of a dropdown. This provides better visibility of the guidance text while maintaining the same functionality. Changes made in commit 75ed189.

Co-authored-by: cijothomas <5232798+cijothomas@users.noreply.github.com>
@Copilot Copilot AI requested a review from cijothomas July 2, 2025 17:28
Copilot finished work on behalf of cijothomas July 2, 2025 17:28
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.

Improve issue templates
2 participants