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

meta: make more bug-report information required #53718

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

RedYetiDev
Copy link
Member

This PR makes the following sections required when filing a bug report:

  • What steps will reproduce the bug?
  • How often does it reproduce? Is there a required condition?
  • What is the expected behavior? Why is that the expected behavior?

In my opinion, many bug reports will see that only the 'What do you see instead?' section is required, and file the entire report in that section. These other sections are important, and it can be cumbersome to ask for more information, when the user should've filled it out in the template.

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/tsc
@nodejs-github-bot nodejs-github-bot added the meta Issues and PRs related to the general management of the project. label Jul 3, 2024
@marco-ippolito
Copy link
Member

If its required and they want to leave it empty anyways user can just write a single character and make it pass validation right?

@RedYetiDev
Copy link
Member Author

RedYetiDev commented Jul 4, 2024

Yes, but I still think having it required will incline users to fill it out.

I'm less concerned with users intentionally trying to avoid putting information, but more with users not even trying to find the information, as they see it's not required.

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Issues and PRs related to the general management of the project.
4 participants