csdcorp / speech_to_text

A Flutter plugin that exposes device specific text to speech recognition capability.
BSD 3-Clause "New" or "Revised" License
351 stars 218 forks source link

Tips on submitting #451

Open sowens-csd opened 6 months ago

sowens-csd commented 6 months ago

You're likely here because you're having trouble getting speech recognition working. Here are some tips to help you get the information you need.

Before you submit:

  1. Try the example app
  2. Read the README, especially the troubleshooting section. As others find issues I've added them to the troubleshooting guide.
  3. Try it on a physical device, not a simulator. Simulators are creatures of chaos, getting them to work is finicky and uncertain.

In your issue

  1. Include the OS and version information: iOS version 16.4 or ...
  2. Include information about the device you tried: iPhone 14 or Google Pixel 6 or...
  3. Include the version of the plugin you are using: Plugin version 6.4.0 or ...
  4. Include the Flutter version you're using: Flutter Version 3.13.7 or ...
  5. Give a clear description of what you tried and what you expected and where it happened.
  6. Try a run with debug logging turned on and provide the log with your issue. You turn debug logging on in the initialize call by setting the debugLogging: true parameter.
  7. I'm not going to read any substantial amount of your code to try to find a problem. A small snippet of code may be helpful if it helps clarify the issue.