Skip to content
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

[FEATURE] Improve Device Information Input in Bug Issue Template #328

Open
2 tasks done
Adi-204 opened this issue Feb 24, 2025 · 3 comments · May be fixed by #329
Open
2 tasks done

[FEATURE] Improve Device Information Input in Bug Issue Template #328

Adi-204 opened this issue Feb 24, 2025 · 3 comments · May be fixed by #329
Labels
enhancement New feature or request

Comments

@Adi-204
Copy link

Adi-204 commented Feb 24, 2025

Why do we need this improvement?

Currently, the issue template uses a dropdown for browser selection. However, this approach limits users to predefined options and does not allow specifying additional details such as OS, browser version, or other relevant system information. This can lead to missing or incomplete information, making it harder for maintainers to diagnose issues effectively. Additionally, if a user is using an uncommon browser that is not listed, they are forced to select "Other" without providing further details.

Proposal:
Replace the dropdown with a free-text textarea field labeled Device Information [optional], allowing users to provide OS, browser name and version.

How will this change help?

By replacing the dropdown with a free-text textarea for Device Information, users can provide more complete and structured details about their environment, including:

  1. Operating System (OS): Helps identify platform-specific issues.
  2. Browser Name & Version: Ensures compatibility across different browser versions.

This improvement will enhance issue reporting, reduce the need for back-and-forth clarification, and help maintainers debug problems faster.

Screenshots

No response

How could it be implemented/designed?

Make changes in bug ISSUE_TEMPLATE.

🚧 Breaking changes

No

👀 Have you checked for similar open issues?

  • I checked and didn't find a similar issue

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue?

Yes I am willing to submit a PR!

@Adi-204 Adi-204 added the enhancement New feature or request label Feb 24, 2025
Copy link

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@Adi-204
Copy link
Author

Adi-204 commented Feb 24, 2025

Waiting for approval from maintainers. Once confirmed, I’m ready to implement this change. Thanks : )

@derberg
Copy link
Member

derberg commented Mar 3, 2025

please go ahead with change,

can you make a change with some comment in a template, that suggest what kind of info is needed, about browser and os?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants