Skip to content

How to ask questions in correct way

Erwin Ried edited this page May 27, 2024 · 13 revisions

Tip

Please read the wiki first; it resolves 99% of issues. Think of it as your troubleshooting sidekick.

If your problem isn't documented, ask in our GitHub issues or on our Discord server. To save time, follow these guidelines:

  • Be specific.
  • Provide detailed descriptions.
  • Avoid cross-posting in Discord channels.
  • Use screenshots, not phone camera photos. If you must use a camera, zoom out to avoid moiré patterns.
  • For hardware issues, take clear, well-lit photos.
  • Use markdown syntax for code or error messages.

Examples

Good Question

I have {specific problem}. I followed the {guide}, but it failed at {step}. The error message is {error}. Here’s a screenshot. My computer environment is {details}, and my device is {details}. Here are some clear photos that might help.

Bad Questions

Asking Vaguely

  • Can anyone help me? I need help. Please.
  • Hello, anybody here?
  • Help me!

Too Wide-Ranging

  • How do I write an app for this device?
  • How do I attack/jam {device}?

Lacking Detail

  • {Feature} not working, please help.
  • My device is not working, please help.
  • I can't update firmware.

Easily Googled Questions

Start here

How to collaborate
How to ask questions correctly

User manual

Developer Manual

Clone this wiki locally