How to report bugs and provide feedback

Developer Tools Particle Workbench
1

Hello Particle Workbench users :wave:

We greatly value your feedback - to help us better diagnose and fix your issue as quickly as possible, here's what you can do:

  1. Search in the community for similar reports - often times your question will have already been asked and answered
  2. Create a new topic / thread and include the "[ISSUE]" prefix - this will help us quickly differentiate bug reports from general questions / discussion
  3. Verify you are using the latest versions of VSCode & Particle Workbench - there's a decent chance we've already fixed your issue. Here's how to update extensions and how to update VSCode
  4. Disable Other Extensions - VSCode extensions can interact poorly. To help identify these scenarios, please reproduce your issue with all non-Workbench extensions disabled. Here's how to disable extensions
  5. Disable Antivirus - some antivirus programs interfere with VSCode / Particle Workbench - temporarily disable or explicitly grant VSCode higher privileges and confirm your issue is still present
  6. Bypass USB hub / extensions - if you are working with a device and are seeing issues related to its USB connection, try disconnecting all USB devices and reconnecting only your Particle device directly to you computer’s USB port.
  7. Check your USB Cable - Likewise, if you are having issues connecting to your device over USB, try using a different cable. You'd be surprised how many "power-only" USB cables are out there.
  8. Avoid Cloud Storage Drives Storing your project in Dropbox / OneDrive / Google Drive? Try moving it to a standard directory
  9. Avoid Custom Shell Commands - Local compilation on macOS & Linux relies on a number of standard shell commands (e.g. cd, ls, rm, stat, etc). In rare cases a developer may choose to replace these standard built-in commands with custom versions that behave differently. Verify you are not using custom shell commands or disable them temporarily and re-test your issue.
  10. Please provide clear steps to reproduce your issue - what chain of events lead to the issue? what happened? what did you expect would happen?
  11. Include an Environment Audit Report - run the Particle: Audit Environment command (docs) and include the nonsensitive portions in your issue details

Thanks for using Workbench and thanks for helping us make it better for everyone :pray:

2 Likes