From 533746a479754d262463a67f075524410407afd2 Mon Sep 17 00:00:00 2001
From: Arno Gourdol <arno@arno.org>
Date: Sat, 2 Sep 2023 08:15:01 -0700
Subject: [PATCH] chore: updated template

---
 .github/ISSUE_TEMPLATE.md | 62 +++++++++++++++++++++------------------
 1 file changed, 34 insertions(+), 28 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index fbc9d4ae0..4f73f4b57 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,50 +1,56 @@
-## Description
+>  Please follow the template below. 
+>  If you don't, your issue may be closed without being addressed.
+
+
+>  Include code fragments or CodePen.io links to illustrate the issue. Do not include screenshots of code.
+  
+>  If you get a runtime or TypeScript error, copy the text of the error message, from the JavaScript console, for example. Do not include a screenshot of the error message.
+
+>  If the issue is with rendering of the math, please include the LaTeX code that is causing the issue as text. Do not include a screenshot of LaTeX code.
+
 
-[If the issue has to do with MathJSON or the Compute Engine, please report it
-here: https://github.com/cortex-js/compute-engine/issues]
+>  Screenshots or recording can be useful to illustrate a visual or interactive issue, however also provide a description of the problem in text.
 
-[Describe the bug or feature]
+>  Do not include screenshots of code, error messages or LaTeX.
 
-[Include code fragments or CodePen. If you get an error, copy the text of the
-error message (from the JavaScript console, for example). Include screenshots or
-screen recordings to illustrate a visual or interactive issue.]
 
-[If you use Vue, React or some other framework, include a link to a minimal
-project demonstrating the issue.]
+>  If you use React, Vue or some other framework, try to provide some code that replicates the issue using only plain JavaScript. If you can't, then include a link to a minimal project demonstrating the issue. This will make it **much** easier to reproduce the issue and fix it.
 
-[To quickly build a demo project, consider
+> If the issue has to do with the Compute Engine or MathJSON, please report it
+here: https://github.com/cortex-js/compute-engine/issues
 
-- (https://github.com/mindreframer/mathlive-bug-issue-templates)
-- (https://github.com/mindreframer/mathlive-create-app) ]
+>  If the issue is related to the documentation on cortexjs.io or the behavior of cortexjs.io, please report it here: https://github.com/cortex-js/cortexjs.io/issues
 
-## Steps to Reproduce
+## Description
+
+> (Optional) Provide a brief summary of the issue.
+
+### Steps to Reproduce
 
-[Provide steps that are specific and repeatable]
+> (Required) Provide steps that are specific and repeatable
 
-1. [First Step]
-2. [Second Step]
+1. [First I did this...]
+2. [Then I did that...]
 3. [And so on...]
 
 ### Actual Behavior
 
-[What happens when you follow the steps above?]
-
-[If there are any error messages, include the exact text shown. Some error
-messages may be displayed in the Javascript console. Copy and paste them. Do not
-include a screenshot of the error messages.]
+> (Required) What happened when you followed the steps above?
 
 ### Expected Behavior
 
-[What did you expect to happen instead?]
+> (Required) What did you expect to happen instead? It may be obvious to you what should have happened, but if you don't state it explicitly it may not be obvious to others.
 
-[Is this a regression: did it use to work in a previous version?]
 
 ### Environment
 
-**MathLive version**
+> Is this a regression: did it use to work in a previous version?
+
+**MathLive version**  _If using the cortexjs.io site, the version is displayed
+at the bottom of the page. If using the library, the version is available as 
+`MathfieldElement.version`_
 
-**Operating System** [macOS, Windows, iOS. Include the version]
+**Operating System** _macOS, Windows, iOS. Include the version_
 
-**Browser** [Safari, Chrome, IE, Firefox, etc... Try several browsers and note
-if there are differences between browsers. Include the version number of the
-browsers.]
+**Browser** _Safari, Chrome, Edge, Firefox, etc... Try several browsers and note
+if there are differences between browsers._