From cdf2935c3d18d7f0e5a291094fd4d4424b5c9a9c Mon Sep 17 00:00:00 2001 From: Miles Malerba Date: Wed, 31 May 2023 21:00:34 +0000 Subject: [PATCH] docs: Update contribution guidelines and issue template regarding issue (#27205) reproductions --- .github/ISSUE_TEMPLATE/bug.yml | 11 ++++++++--- CONTRIBUTING.md | 11 ++++++++--- 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 1239583a47f7..4a16ce7f3854 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b814f9ff2de..c3aaee377fd0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,9 +31,14 @@ If you would like to chat about the question in real-time, you can reach out via ## 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.