Skip to content

Commit

Permalink
make local verification more prominent
Browse files Browse the repository at this point in the history
  • Loading branch information
jrvidal committed Mar 21, 2022
1 parent 44ef1d4 commit 494fbff
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
5 changes: 4 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ body:
value: |
Thank you for reporting an issue :pray:.
Please read our [guidelines to report issues](https://github.com/stackblitz/webcontainer-core/blob/main/repro.md).
This issue tracker is for bugs and issues found within WebContainer.
If you experience issues unrelated to WebContainer, please file an issue in our StackBlitz core repo. https://github.com/stackblitz/core
Expand Down Expand Up @@ -49,7 +51,8 @@ body:
label: Parity with Local
description: Does the issue appear only when running the WebContainer project? Or does it also appear locally?
options:
- label: I have run the project in my local machine and I could not reproduce the issue.
- label: I have [run the project in my local machine](https://github.com/stackblitz/webcontainer-core/blob/main/repro.md#try-locally) and I could not reproduce the issue.
required: true
- type: textarea
id: screenshots
attributes:
Expand Down
4 changes: 4 additions & 0 deletions repro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

In general, we always prefer a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) when looking at a bug report. Here are a few things you can do to write the perfect example when you encounter an issue with WebContainer.

## Try Locally
If a project is not working as expected, it might be due to an incompatibility with WebContainer. However, please do check that the project runs as expected in your local machine, with your Node installation. If it does run without issue locally, we are much more certain that we might be after a WebContainer compat issue.

For some types of issues, it might not make sense to perform this verification, e.g. if you have an issue with the editor.

## Auto-execute Erroneous Command
We always ask you to include a link to a blitz that shows the erroneous behavior. You can make things even easier to reproduce if you configure it so the command that triggers the error is run automatically on start. You can do that by including a [custom `.stackblitzrc` configuration file](https://developer.stackblitz.com/docs/platform/project-config).
Expand Down

0 comments on commit 494fbff

Please sign in to comment.