TheArchive/mayhem-firmware
1
0
Fork 0
mirror of https://github.com/portapack-mayhem/mayhem-firmware.git synced 2024-11-23 18:15:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Small rewrite

Erwin Ried 2024-05-27 10:37:13 +02:00
parent 12eb6902bb
commit 16388a55dc
1 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
How-to-ask-questions-in-correct-way.md

@ -1,42 +1,42 @@
99% of problems that you are facing can be resolved by reading the wiki, so please read the wiki first.
> [!TIP]
> Please read the wiki first; it resolves 99% of issues. Think of it as your troubleshooting sidekick.
If you are sure you are facing an issue that not documented in wiki, please ask in our GitHub issue or our discord server.
If your problem isn't documented, ask in our [GitHub issues](https://github.com/portapack-mayhem/mayhem-firmware/issues/new/choose) or on our [Discord](https://discord.gg/tuwVMv3) server. To save time, follow these guidelines:
To prevent wasting your own time and others' time, you should ask questions in correct way:
* Don’t ask for ask, just ask.
* Describe details.
* Be specific.
* Provide detailed descriptions.
* Follow the guide.
* Ask smart.
* Don't cross posts discord channels
* Don't capture screen with phone camera, use screenshots instead. If you have to, zoom your camera lens and far to screen to prevent moiré pattern
* If it's about hardware, take clear photos, focus the object, zoom if needed, make sure it's bright enough.
* If you post code or error message, ``use markdown syntax to surround them``
* Ask smart questions.
* 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
## Good Question
I have xxxxx problem, I have followed the xxxx guide, but it doesn’t work. Because it failed at step x, when it fail, it shows xxxxxxx, and here’s the screenshot. Also my computer environment is xxxxxx, my device is xxxx, here are some detail clear photos that might help.
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
## Bad Questions
### ask for ask
### Asking Vaguely
* can anyone help me? I need help. Please.
* hello, anybody here?
* Help me! < a screenshot without any explanation >
* Can anyone help me? I need help. Please.
* Hello, anybody here?
* Help me! <a screenshot without explanation>
### ask too wide-ranging questions
* Please tell me how to write an app for this device
* How do I attack xxx, jam xxx
### Too Wide-Ranging
* How do I write an app for this device?
* How do I attack/jam **{device}**?
### no detail
* xxxx not work, please help
* my device not working, please help
* I can't update firmware
### Lacking Detail
* **{Feature}** not working, please help.
* My device is not working, please help.
* I can't update firmware.
### asking questions that can be googled
* What is xxx?
### Easily Googled Questions
* [What is **{term}**?](https://letmegooglethat.com/?q=What+is+%7Bterm%7D%3F)