When asking questions
- Search existing resources before asking; Use categories and tags to compare your question to existing content
- Make your question title clear and concise; Be as specific as possible to make your issue identifiable.
- Provide relevant code examples and error messages; Add as much information as necessary to increase clarity. Include error messages, version numbers, screenshots, code, links to relevant docs, or anything that will make it easier to understand what issue you are trying to solve, while avoiding excessive posting of large code dumps or extensive logs.
- Explain what you’ve already tried
- Test code before sharing it with the community
- Use appropriate formatting for code snippets, quotes, and general text.
When answering questions
- Be patient and constructive in your responses
- Explain concepts thoroughly instead of just providing solutions
- Link to relevant documentation when applicable
- Avoid dismissive responses like “just Google it” or “read the documentation”
- Help others learn by explaining your thought process
When reporting issues or suggesting features
- Check if the issue has already been reported
- Provide clear steps to reproduce the problem
- explain your motivation and what you are trying to achieve
- Include relevant system information and context
- Be responsive to follow-up questions
- Update the issue if you find additional information