How to ask questions on the web - a checklist

Rong GONG
1 min readDec 31, 2020

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:

  1. Search Google
  2. Read manual
  3. Read FAQ
  4. Search the forum posts
  5. Do some experiments
  6. Ask someone that we are familiar with
  7. Read the code

A clear title

Write two things, the first is the objective, the second is the current situation.

Describe the problem

  1. Describe the problem, don't make assumptions.
  2. Be precise at what kind of help we want to get: code script e.g.
  3. 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.

--

--