When something goes wrong

Reporting a bug with F12

Press F12 anywhere in the Studio. It freezes what you are looking at, hands you a pen to circle the problem, and sends the whole thing with the technical details already attached.

WhatWhere you'll find it
Report a bugF12, or Help → Report a Bug…
After a crash or freezeThe banner the next time you open the Studio
Queued reports%LOCALAPPDATA%\SprinkFlow\bug-reports

Filing one

  1. Press F12 while the problem is on screen. It works from anywhere — even while you are typing in a field, because “it went wrong while I was typing” is a bug report too.
  2. The drawing view freezes into a screenshot. Draw on it: scribble freehand, drop an arrow, or drag an ellipse around the area. One colour, three tools, an undo — it is not a paint program on purpose.
  3. Write what happened. What you expected is usually the actual bug report.
  4. Pick a severity: Normal — it's wrong but I can work around it (the default), Low — cosmetic or minor, or Blocker — I can't keep working.
  5. Optionally pick a category: Drawing, Snapping, Import, Export, Performance, Crash, Other. “Not sure” is a perfectly good answer.
  6. Press Send. You get a report number back — quote it if you follow up.

What gets sent

The dialog lists every file before you press Send, with its real size. Typically:

There is a tick for including a copy of your project. It makes a report far easier to reproduce, and it is entirely your call — untick it and the project snapshot is removed from the bundle before anything is sent. Nothing else in the bundle is your client's drawing.

Your drawings are never uploaded in the background. The Studio only sends what a report you wrote says it is sending.

If the send fails

Offline, on a plane, or the service is down: the whole report — your words, your marked-up screenshot, the bundle — is written to disk under %LOCALAPPDATA%\SprinkFlow\bug-reports and sent quietly the next time you open the Studio. You never lose five minutes of writing to a failed upload.

It tries once per report per launch. A report that fails twice would fail the same way a third time, and an upload storm helps nobody.

After a crash or a freeze

If the Studio crashed or locked up, it leaves a short note behind. The next time you open it a banner offers to send that note — the description is filled in for you and the severity is set to Blocker. The banner appears once; ignore it and it will not nag, though a newer problem will prompt again.

The large memory dump a freeze produces is never uploaded. It is gigabytes of your machine's memory, including the drawing you were working on. The note beside it is a few hundred bytes and says what the program was doing, which is the part anyone actually reads.

What makes a report useful

Related