This article explains where to get help with the Documentarian modules. Please read and follow the following guidelines.
Note: Please read our code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
Questions can go to GitHub discussions.
Help us help you! Spend time framing questions and add links and resources. Spending the extra time up front can help save everyone time in the long run. Here are some tips:
- Talk to a duck!
- Don't fall for the XY problem
- Search to find out if a similar question has been asked
- Try to define what you need help with:
- Is there something in particular you want to do?
- What problem are you encountering and what steps have you taken to try and fix it?
- Is there a concept you don't understand?
- Provide sample code or video, if possible
- Screenshots can help, but if there's important text such as code or error messages in them, please also provide those as text
- The more time you put into asking your question, the better we can help you
See our contributing documentation for more information on how you can contribute to the project.
This document was adapted from the remark support file.