-
Notifications
You must be signed in to change notification settings - Fork 843
Asking Technical Questions
Please review the following guidelines in order to ask the best question possible.
Open your question with a title/heading. This is the first thing someone will see when providing an answer. Think about your problem carefully, and then try to summarize the problem in a short and clear manner.
These are some examples of helpful openings for a technical question.
- How can I ... ?
- Is it possible to ... ?
- Are there any ... ?
- Why do ... ?
If you're having trouble summarizing the problem, write the title last - sometimes writing the rest of the question first can make it easier to describe the problem.
Before providing some code examples, explain the problem in more detail in an opening paragraph. This should provide more context to the opening title.
Provide steps to reproduce the issue. Always include a minimal reproducible example if your question depends on code. It will allow others to reproduce the issue.
Try to format your code examples with sensible spacing, and follow popular conventions if possible.
Note: Don't include screenshots of code examples. All code should be in code blocks/plain text which allows users to copy text easily, and to make it accessible for everyone. Please reserve the use of images for diagrams, demonstrating rendering bugs, etc.
If your project or question has any constraints or restrictions which means you can't use a particular solution, make sure to mention these limitations.
Try to list what you have tried already. It will mean someone who helps you doesn't have to debug the problem from the very start.
Are you sure the answer can't be found in our documentation? You can find our documentation online.
Writing in a foreign language is difficult. Once you have finished writing your problem, take some time to proofread and review the text. Is there anything about it you can improve? Pay attention to spelling, grammar and punctuation.
Tools like Grammarly can automatically scan your text and advise on improving the grammar. It has extensions for all modern browsers.
Translators like Deepl or Google Translate can also help you improve your questions.
Any extra help you can provide is always appreciated. If it's possible to create a live example that shows your problem, it can be very helpful.
Create an online demo with some of the following services, and provide a link:
It's possible somebody has already created a discussion on this topic. Try searching for the topic before creating a new discussion.
If you create a question that has already been answered, the discussion will be marked as a duplicate.
If you are satisfied that your question has been answered, press the 'Mark as answer' button on the chosen answer.
This has a few benefits:
- It gives a clear indication your problem is solved.
- The chosen answer will be pinned to the top of the discussion making it easier for other users to find.
- It enables users to search discussions using a filter of 'Answered'.