From 4e9c7eeb5cff87a872d06f3ab818de78b8f51040 Mon Sep 17 00:00:00 2001 From: Arno Gourdol Date: Fri, 5 Jul 2024 12:01:29 -0700 Subject: [PATCH] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 38 ++++++++-------------------- 1 file changed, 11 insertions(+), 27 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c24e1dfd..67e0e67f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- name: Bug report -about: Create a report to help us improve +about: Create a report to help us improve the Compute Engine title: '' labels: '' assignees: '' @@ -15,38 +15,25 @@ assignees: '' > 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. - - -> Screenshots or recording can be useful to illustrate a visual or interactive issue, however also provide a description of the problem in text. - > Do not include screenshots of code, error messages or LaTeX. - -> 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. - -> If the issue has to do with the Compute Engine or MathJSON, please report it -here: https://github.com/cortex-js/compute-engine/issues - > 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 ## Description -> (Optional) Provide a brief summary of the issue. +> (Optional) Provide a brief summary of the issue. You don't need to repeat the title. ### Steps to Reproduce -> (Required) Provide steps that are specific and repeatable +> (Required) Provide JavaScript or TypeScript code that demonstrate the issue +> Only include the code that is necessary to demonstrate the issue. +> You don't need to include HTML. -1. [First I did this...] -2. [Then I did that...] -3. [And so on...] +### Actual Result -### Actual Behavior +> (Required) What happens when the code above is executed -> (Required) What happened when you followed the steps above? - -### Expected Behavior +### Expected Result > (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. @@ -55,11 +42,8 @@ here: https://github.com/cortex-js/compute-engine/issues > 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 +**Compute Engine 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_ +`window[Symbol.for('io.cortexjs.compute-engine')].version` in the browser or by importing +`version` from the library._ -**Browser** _Safari, Chrome, Edge, Firefox, etc... Try several browsers and note -if there are differences between browsers._