Skip to content

Commit dce761c

Browse files
committed
docs: Update contribution guidelines and issue template regarding issue
reproductions
1 parent 3749308 commit dce761c

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,15 @@ body:
2828
attributes:
2929
label: Reproduction
3030
description: |
31-
**Use StackBlitz to reproduce your issue:**
32-
- [Components](https://stackblitz.com/fork/components-issue)
33-
- [Harnesses](https://stackblitz.com/fork/harness-issue)
31+
Use StackBlitz to reproduce your issue:
32+
- [Components StackBlitz starter](https://stackblitz.com/fork/components-issue)
33+
- [Harnesses StackBlitz starter](https://stackblitz.com/fork/harness-issue)
34+
35+
Issues that do not include a StackBlitz (or other REPL) reproduction link will be closed.
36+
If it is not possible to create a StackBlitz reproduction for your issue, please explain why
37+
and include any other information you can to help the team reliably reproduce the issue.
3438
value: |
39+
StackBlitz link:
3540
Steps to reproduce:
3641
1.
3742
2.

CONTRIBUTING.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,13 @@ If you would like to chat about the question in real-time, you can reach out via
3131

3232
## <a name="issue"></a> Found an Issue?
3333
If you find a bug in the source code or a mistake in the documentation, you can help us by
34-
[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Including an issue
35-
reproduction (via CodePen, JsBin, Plunkr, etc.) is the absolute best way to help the team quickly
36-
diagnose the problem. Screenshots are also helpful.
34+
[submitting an issue](#submit-issue) to our [GitHub Repository][github].
35+
36+
For bugs, including an issue reproduction (via your preferred REPL: StackBlitz, CodePen, JsBin,
37+
Plunkr, etc.) is the absolute best way to help the team quickly diagnose the problem. Issues that do
38+
not include a REPL reproduction will be closed. If a REPL reproduction is not possible for your
39+
issue, please explain why and include any other information that may be helpful in debugger (link to
40+
a repo, error messages, screenshots, etc.)
3741

3842
You can help the team even more and [submit a Pull Request](#submit-pr) with a fix.
3943

0 commit comments

Comments
 (0)