Skip to content

docs: Update contribution guidelines and issue template regarding issue reproductions #27205

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 31, 2023
Merged

docs: Update contribution guidelines and issue template regarding issue reproductions #27205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions .github/ISSUE_TEMPLATE/bug.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,15 @@ body:
attributes:
label: Reproduction
description: |
**Use StackBlitz to reproduce your issue:**
- [Components](https://stackblitz.com/fork/components-issue)
- [Harnesses](https://stackblitz.com/fork/harness-issue)
Use StackBlitz to reproduce your issue:
- [Components StackBlitz starter](https://stackblitz.com/fork/components-issue)
- [Harnesses StackBlitz starter](https://stackblitz.com/fork/harness-issue)

Issues that do not include a StackBlitz (or other REPL) reproduction link will be closed.
If it is not possible to create a StackBlitz reproduction for your issue, please explain why
and include any other information you can to help the team reliably reproduce the issue.
value: |
StackBlitz link:
Steps to reproduce:
1.
2.
Expand Down
11 changes: 8 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,14 @@ If you would like to chat about the question in real-time, you can reach out via

## <a name="issue"></a> Found an Issue?
If you find a bug in the source code or a mistake in the documentation, you can help us by
[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Including an issue
reproduction (via CodePen, JsBin, Plunkr, etc.) is the absolute best way to help the team quickly
diagnose the problem. Screenshots are also helpful.
[submitting an issue](#submit-issue) to our [GitHub Repository][github].

For bugs, include an issue reproduction (via your preferred REPL: StackBlitz, CodePen, JsBin,
Plunkr, etc.) Our team has limited resources, and this allows us quickly diagnose issues and make
optimal use of the time we dedicate to fixing them. Issues that do not include a REPL reproduction
will be closed. If a REPL reproduction is not possible for your issue, please explain why and
include any other information that may be helpful in debugger (link to a repo, error messages,
screenshots, etc.)

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

Expand Down