How to ask questions in correct way - portapack-mayhem/mayhem-firmware GitHub Wiki
[!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 in 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.
I did {detailed steps of what you did} and it caused {details of your ploblem}. 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} with {firmware version}. 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/copy/clone {device/station/fob/remote}?
Lacking Detail
- {Feature} not working.
- My device is not working, please help.
- I can't update firmware.
- I can't receive.
- I can't transmit.