Skip to content
Yinan Zhou edited this page Jan 28, 2022 · 6 revisions

Reporting Issues

Have you found an issue in Neon? Here's what to do:

  1. Go to our issue page
  2. Search for you issue, keeping is:issue but removing is:open. It's possible someone else has already reported this issue and that it may be fixed, but not currently in the release you're using.
  3. If the issue has already been reported, feel free to add a comment with more information.
  4. If the issue hasn't been reported, then you should create a new issue. Please look at the section on writing a good issue report.

Submitting issues

If you need to report an issue, it helps to give us all the information you have. This includes:

  • Version number. This is either the release (X.Y.Z) or the commit where you encountered the problem.
  • What you were doing. Tell us exactly what caused the issue. If you're able to give us the minimum set of steps to reproduce the issue, all the better.
  • What you were using. If you're able to share the files you had loaded, include them in the issue. If the files are too large and a problem is only encountered in a part of them, include a snippet that causes the issue.
  • Error messages, if any. Neon often reports errors in the console of your browser. In Firefox, right click on the page, click "Inspect Element" and then click on the "Console" tab of the bar that appears. In Chrome, right click on the page, click "Inspect" and click on the "Console" tab of the bar that appears. Warnings (messages in yellow) and errors (messages in red) might be relevant.

The issue title should either be a brief description of what happens or an error message, if one exists.

Cross-Project Issues

Neon depends on Verovio and uses our own fork. It also has a Rodan wrapper. Issues may appear that require changes in either project, or for the wrapper only appear in that frontend. These issues have the Verovio-Neon and Neon-Wrapper labels respectively. Unless you're sure that an issue requires work in either of those projects, don't add these labels.