Skip to main content

Reporting a Defect

If you hit a bug, the app can put together a detailed report for you to copy and paste into an email, chat message, or GitHub issue — no need to manually write up the map, browser, and console details yourself.

Where to find it​

Click the bug icon in the sidebar's utility row, next to your avatar (alongside the documentation and theme buttons). No need to open the user menu first — this button is always available, whether or not you have a map open.

What gets included​

Before you copy, the dialog shows you every category of data that will be included in your report:

  • Map: the name, ID, and a link to the map you had open, if any (omitted if no map is open — reporting a bug doesn't require one)
  • App version: the build identifier of the app you're running, so a maintainer can tell which deployed version produced the report
  • Browser/OS/viewport: your browser's user agent string and window size
  • Active features: whether the System Dynamics layout, a simulation, or a collaboration session were active at the time
  • Recent console errors: the dialog's preview shows a count of the last errors logged in your browser's console this session (up to the most recent 20); the copied report includes their full text and timestamps, not just the count
  • Your identity: your display name, email, and account ID, so a maintainer can follow up with you if needed

No category of data beyond what's listed above is ever copied — if it's not listed there, it's not included in the report. (The console-errors bullet above is the one case where the preview shows a summary — a count — while the copied report includes the full underlying detail.)

Filing a report​

  1. Click the bug icon to open the dialog.
  2. Enter a title summarizing the problem.
  3. Enter a description: what happened, and what you expected instead.
  4. Click Copy report to clipboard.

Both the title and description are required — the copy button stays disabled until you've filled in both.

What happens next​

There is currently no automated way to file the copied report as a GitHub issue directly from the app — that's tracked separately (issue #206). For now, clicking Copy report to clipboard copies the full formatted report (title, description, and all the auto-captured context above) so you can paste it into a new GitHub issue yourself (if you have access to verveguy/concept-maps) or send it to a maintainer another way (chat, email). You'll see a confirmation once the copy succeeds.

If the copy fails (e.g. your browser blocked clipboard access), you'll see an error along with a read-only text box containing the full report — select its contents and copy manually.