Skip to content

Commit 494fbff

Browse files
committed
make local verification more prominent
1 parent 44ef1d4 commit 494fbff

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ body:
66
value: |
77
Thank you for reporting an issue :pray:.
88
9+
Please read our [guidelines to report issues](https://github.com/stackblitz/webcontainer-core/blob/main/repro.md).
10+
911
This issue tracker is for bugs and issues found within WebContainer.
1012
If you experience issues unrelated to WebContainer, please file an issue in our StackBlitz core repo. https://github.com/stackblitz/core
1113
@@ -49,7 +51,8 @@ body:
4951
label: Parity with Local
5052
description: Does the issue appear only when running the WebContainer project? Or does it also appear locally?
5153
options:
52-
- label: I have run the project in my local machine and I could not reproduce the issue.
54+
- 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.
55+
required: true
5356
- type: textarea
5457
id: screenshots
5558
attributes:

repro.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
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.
44

5+
## Try Locally
6+
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.
7+
8+
For some types of issues, it might not make sense to perform this verification, e.g. if you have an issue with the editor.
59

610
## Auto-execute Erroneous Command
711
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).

0 commit comments

Comments
 (0)