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

chore: make reproduction field a textarea #10353

Merged
merged 2 commits into from
Oct 7, 2022
Merged

Conversation

benmccann
Copy link
Collaborator

Description

The reproduction field in the issue tracker asks for steps, but it's just a single line, so I can't include them.

Example: #10352

Additional context

This is discussed in #contributing on Discord


What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines and follow the Commit Convention.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

@antfu
Copy link
Member

antfu commented Oct 5, 2022

I am not sure about it. I personally think having it as one line field shares the message that it requires a "link" to a repo or playground, but not "steps descriptions". Despite that, some might still open issues without repro, @patak-dev was even asking to restrict it with RegExp or so.

I consider your case is valid, but I think maintainers like us who already know the importance of repro and also know how to workaround the limitation could keep using the workaround. While leaving the form restricted to limit reporters who are not yet familiar with open source.

@bluwy
Copy link
Member

bluwy commented Oct 6, 2022

I'm in favor with a textarea as I sometimes see repro steps placed inside the issue description. The placeholder for the field now is also "Reproduction URL and steps" so I think it's clear that they need the URL. We can also try to see if this change brings an uptick of repros without links too.

@patak-dev
Copy link
Member

I'm with @antfu on this one after looking at the example that triggered this issue: #10352. This issue has a proper reproduction link.

What if we have an extra optional field after reproduction that is a Text Box: "Steps needed to reproduce (optional, if not clear or specified in the reproduction readme)" ?

@bluwy
Copy link
Member

bluwy commented Oct 6, 2022

I'm fine with an extra optional field for steps too 👍

@sapphi-red
Copy link
Member

Having an extra optional field for steps sounds better to me.

@sapphi-red sapphi-red added the p1-chore Doesn't change code behavior (priority) label Oct 6, 2022
@benmccann
Copy link
Collaborator Author

An extra field sounds fine to me. I've gone ahead and made that change

@patak-dev patak-dev merged commit 2401253 into vitejs:main Oct 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p1-chore Doesn't change code behavior (priority)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants