Open Whisper Docs

Appendix A6 Reporting a problem

Reading time · 3 min

Where to report a problem or suggest an idea, what makes a report solvable, and what happens after you send it.

Something not working, or an idea to suggest? Tell us in public, on the project's issue page. This page says what to include, what to leave out, and what to expect.

Where to report

  1. First look at Troubleshooting: the fix may already be there.
  2. Check what has already been reported. If your problem is there, add what you see to it.
  3. Otherwise, open a new issue. You need a GitHub account.

Write in the language you prefer. The answer comes in the language the issue was written in.

What makes a good report

  • What you expected, and what happened instead. "The text went to the clipboard instead of into the document" can be solved. "It doesn't work" can't.
  • The app you were dictating into. Pasting behaves differently in a browser, a code editor and a chat app, and this is usually the deciding detail.
  • The steps, in order, from the shortcut press to what you saw.
  • Whether it happens every time, or only sometimes.
  • Your system and its version: macOS 14, 15…, or Windows 10 or 11.
  • The app version and build. Open About Open Whisper from the menu and copy the line Version … (build …): you can select it.
  • Your mode and shortcut, if the problem is about recording: Hold to Talk or Toggle.
  • For the command line: the command you ran, the exit status, and the last line it printed.

Keep private text out

If the problem is about the words themselves (a name always misspelled, a language mixed up), make up a sentence that shows it, and dictate that.

What to expect

  • Every issue is read and answered.
  • A refusal always comes with a concrete reason. "Out of scope" on its own is not an answer.
  • No date is ever promised. "Accepted and queued" is as far as it goes.
  • When something you reported ships, you're told on your issue.
  • If a fix doesn't hold, reopen the issue.

What the labels mean

Each issue gets labels that say where it stands.

LabelMeans
triage: pendingReceived, not looked at yet
triage: acceptedReal, and it's in the queue
triage: needs-infoWaiting on something from you
triage: under-reviewNeeds a product decision before an answer is possible
triage: duplicateAlready reported: the link points to the original
triage: out-of-scopeDeclined, with a concrete reason in the comments
status: queuedAccepted and waiting its turn
status: in-progressBeing worked on
status: awaiting-releaseFixed, waiting for a version to ship it
status: shippedAvailable in a released version
status: closed-unresolvedClosed without a fix, with the reason stated

An idea that touches something Open Whisper deliberately doesn't do is weighed, not closed on sight: see What Open Whisper doesn't do.