Skip to content
This repository has been archived by the owner on Nov 10, 2022. It is now read-only.

Allow users to create bug reports from the demo #510

Open
not-an-aardvark opened this issue Oct 8, 2018 · 1 comment
Open

Allow users to create bug reports from the demo #510

not-an-aardvark opened this issue Oct 8, 2018 · 1 comment
Labels
demo Relates to the ESLint demo page (https://eslint.org/demo) enhancement This change enhances an existing feature of the website

Comments

@not-an-aardvark
Copy link
Member

Problem

Currently, it can be tedious to fill out the sections of the issue template when reporting a bug. Additionally, some bug reports from users don't have enough information to reproduce the reported problem, resulting in some back-and-forth with the user to figure out what the situation is.

Proposed solution

We could have a link in the demo that says "File a bug" and links to a page like this, where most of the sections of the issue template have already been filled in with the information in the demo. This would save some time reporting bugs found in the demo, and it would ensure that all information needed to reproduce the issue is present for bugs reported using this mechanism. Then we could encourage users to attempt to reproduce their bugs in the demo as part of the bug report process, potentially resulting in higher-quality bug reports.

Possible downsides:

  • Users who don't take the time to fill in the bug report template might also not take the time to reproduce a bug in the demo.
  • It's sometimes not obvious how to reproduce a bug in the demo (the only way to use non-default rule configurations in the demo is to use an inline comment, but not everyone knows how to do that).
@not-an-aardvark not-an-aardvark added enhancement This change enhances an existing feature of the website demo Relates to the ESLint demo page (https://eslint.org/demo) labels Oct 8, 2018
@j-f1
Copy link
Contributor

j-f1 commented Oct 8, 2018

Here’s the file Prettier uses to generate the body when clicking “Report issue” in the playground. The code then passes this text to a function that puts it in the URL.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
demo Relates to the ESLint demo page (https://eslint.org/demo) enhancement This change enhances an existing feature of the website
Projects
None yet
Development

No branches or pull requests

2 participants