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

[Docs] CONTRIBUTING.md Reporting A Bug outdated #18460

Closed
Alonski opened this issue Oct 3, 2019 · 5 comments
Closed

[Docs] CONTRIBUTING.md Reporting A Bug outdated #18460

Alonski opened this issue Oct 3, 2019 · 5 comments

Comments

@Alonski
Copy link
Member

Alonski commented Oct 3, 2019

Here: https://github.com/emberjs/ember.js/blob/master/CONTRIBUTING.md#reporting-a-bug
Number 3: States that a Twiddle or JSBin should be provided to showcase the bug.

This should be updated as those aren't necessarily the best ways to showcase a bug.

Possible solutions:

  • Remove JSBin and add CodeSandbox.
  • Remove Twiddle and JSBin and suggest users create a demo repository on GitHub.
@pzuraq
Copy link
Contributor

pzuraq commented Oct 3, 2019

I agree that these seem like the best things folks can do at the moment, since twiddle doesn’t work with the most recent versions of Ember

@rwjblue
Copy link
Member

rwjblue commented Oct 4, 2019

I'd personally prefer to suggest "making a demo repo on GitHub". I wish CodeSandbox was a good enough suggestion, but I just don't find it stable enough to be able to use it to quickly dig into a reported issue.

@mehulkar
Copy link
Contributor

mehulkar commented Oct 5, 2019

I’ve been adding ember-possible-bug to my repro repos! Might be useful to recommend? https://github.com/topics/ember-possible-bug

@alexeykostevich
Copy link

alexeykostevich commented Mar 30, 2020

You've raised a very good issue, @Alonski !

Currently, Contributing docs mention 2 tools:

  • ember-twiddle, which supports multiple versions of Ember.js and Ember CLI.
  • JS Bin, which uses pure Ember.js 1.x.

To cover the whole range of possible issues, it would be ideal if a reproduction environment:

  • supported Ember CLI projects to allow to reproduce issues in the framework and build tools
  • worked online and didn't require a multi-step setup
  • supported external dependencies to reproduce integration issues and issues in community's libraries
  • provided a familiar development experience to let people with different backgrounds (e.g. Angular) to start quickly

Unfortunately, it seems there is no ideal solution right now. The following online IDEs could be a good solutions in the future:

  • StackBlitz — an online IDE with JS/TS, Angular and React support. There is an issue (Ember.js support stackblitz/core#647) for Ember.js support but there is no progress on this so far.
  • CodeSandbox — an online IDE with a wide range of supported frameworks (including Ember.js) but it looks a bit unstable at this point.

From my point of view, while there is no reliable online IDE, ember-twiddle is still a very good option for reproducing simple issues quickly. For more complex scenarios, the docs could recommend a GitHub repository with an Ember CLI project.

However, as @mike-north mentioned, ember-twiddle requires much development/maintenance effort, and it is specific for Ember.js. Therefore, it is likely worth the price to eventually migrate to one of the popular multipurpose online IDEs. Thank you, @mike-north, for all your awesome job on this!

@rwjblue
Copy link
Member

rwjblue commented May 23, 2020

Closed by #18930

@rwjblue rwjblue closed this as completed May 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants