From 5d048ce21ee055ab095a7e8a57caf9b9bd33401d Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Wed, 26 Oct 2022 23:17:15 -0400 Subject: [PATCH] chore: Update bug report template Add common pattern for reproduction with https://mermaid.live/ --- .github/ISSUE_TEMPLATE/bug_report.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f8e453bd3..52efaaaa5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -12,30 +12,32 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +1. Go to the [live editor](https://mermaid.live). +2. Enter the below code sample. -**Expected behavior** -A clear and concise description of what you expected to happen. +**Code Sample** +Live version: A link to https://mermaid.live/edit#… +``` +graph TD; +… +``` **Screenshots** If applicable, add screenshots to help explain your problem. -**Code Sample** -If applicable, add the code sample or a link to the [live editor](https://mermaid.live). +**Expected behavior** +A clear and concise description of what you expected to happen. **Desktop (please complete the following information):** - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] + - Browser: [e.g. chrome, safari] + - Version: [e.g. 22] **Smartphone (please complete the following information):** - Device: [e.g. iPhone6] - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] + - Browser: [e.g. stock browser, safari] + - Version: [e.g. 22] **Additional context** Add any other context about the problem here.