A concise checklist from http://www.catb.org/~esr/faqs/smart-questions.html
Do my own search
Before posting a question, do a search, remember:
- Search Google
- Read manual
- Read FAQ
- Search the forum posts
- Do some experiments
- Ask someone that we are familiar with
- Read the code
A clear title
Write two things, the first is the objective, the second is the current situation.
Describe the problem
- Describe the problem, don't make assumptions.
- Be precise at what kind of help we want to get: code script e.g.
- If we need to paste the code, paste the minimum amount that can show the problem.
Use a template
For issues and pull requests, use https://github.com/devspace/awesome-github-templates
Don't say that you have found the bug
The developers do not want to listen to this.
Say thank you
If your problem has been solved, say thank you.
Write a summary
For the people who have the same problem.