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

feat: improve bug template #5086

Merged

Conversation

pichlermarc
Copy link
Member

@pichlermarc pichlermarc commented Oct 23, 2024

Which problem is this PR solving?

We often get bug reports that don't give full details needed to reproduce.

There's new wording in the placeholder asking for steps to reproduce. There's now more emphasis on asking for reproducer repositories, as well as explaining why this is helpful.

I also added some more emphasis on build instructions and config files for tooling. It's somewhat common that users are very familiar with their stack and assume that we are too. I added a reminder to let them know that JavaScript is a complex ecosystem and that build instructions are immensely helpful in trying to resolve their issue

It's also quite common that users use unsupported runtimes - so I've introduced an optional field where they have to enter their runtime and runtime version so that we can spot it more easily when this is the case.

Finally there's some bugs that only surface on specific Operating Systems - so there's a new optional field for OS and version, which should be relatively easy for the user to provide.

How this looks like

GitHub preview does not fully represent how the issue templates actually looks like, so here's a screenshot of how it will look like (this is on a private repo so asterisks for required fields are missing - they will be there on this repo, since it's public)

image

Copy link

codecov bot commented Oct 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.17%. Comparing base (72c9af9) to head (9f2067b).
Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5086      +/-   ##
==========================================
- Coverage   93.18%   93.17%   -0.01%     
==========================================
  Files         315      314       -1     
  Lines        8086     8076      -10     
  Branches     1617     1622       +5     
==========================================
- Hits         7535     7525      -10     
  Misses        551      551              

see 10 files with indirect coverage changes

@pichlermarc pichlermarc marked this pull request as ready for review October 25, 2024 15:35
@pichlermarc pichlermarc requested a review from a team as a code owner October 25, 2024 15:35
Copy link
Contributor

@maryliag maryliag left a comment

Choose a reason for hiding this comment

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

Nice improvements! Added a few nits

@pichlermarc
Copy link
Member Author

@maryliag thanks for the feedback. 🙌
I've addressed some of the comments and also updated the screenshot with the new changes. I'd appreciate you having another look. 🙂

Copy link
Contributor

@maryliag maryliag left a comment

Choose a reason for hiding this comment

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

Thanks for making the changes!
I just have this nit about the formatting of the steps that you can change or not, otherwise LGTM

Copy link
Contributor

@trentm trentm left a comment

Choose a reason for hiding this comment

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

Happy to have this merged as is, but I have some nits, suggestions, and Qs about "required: true" usage below.

.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
@pichlermarc
Copy link
Member Author

@trentm I addressed some of your comments, two of them are still open - please let me know about your preferred path forward on those.

I also updated the screenshot in the title again to reflect the current state 🙂

- type: markdown
attributes:
value: |
## Basic Troubleshooting
Copy link
Member

Choose a reason for hiding this comment

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

As we talked about offline, it might be more effective if we put all of this (useful!) information into a separate dedicated troubleshooting doc, and link to it from the bug report template

Copy link
Member Author

Choose a reason for hiding this comment

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

Yep - will do, I removed the whole section and will introduce a troubleshooting guide instead. Then I'll introduce a single checkbox along the lines of "I went through the troubleshooting guide but the problem persists" that links to the guide.

I'll also link the guide from README.md.

- type: textarea
attributes:
label: Runtime and Version
placeholder: Node.js v20.12.1, Node.js v18.18.2, Firefox 130, Chrome 132, ...
Copy link
Member

Choose a reason for hiding this comment

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

Consider a note in troubleshooting doc for how to get your version (node --version, etc)

Copy link
Member Author

Choose a reason for hiding this comment

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

I made it optional for now. If someone does not know how to do it they can leave it out. Let's see how well this works when it's optional. If people have problems with finding that info we'll see that bug reports omit the box.

In the follow-up PR to add the troubleshooting doc I'll also update the template here to link to it.

@pichlermarc
Copy link
Member Author

Re-requesting review because the template has changed quite a bit since you all had a look.
I got rid of the troubleshooting section and will add another PR once this is merged to add a dedicated troubleshooting doc.

@pichlermarc pichlermarc added this pull request to the merge queue Nov 15, 2024
Merged via the queue into open-telemetry:main with commit 0c268e7 Nov 15, 2024
19 checks passed
@pichlermarc pichlermarc deleted the feat/enhance-bug-template branch November 15, 2024 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants