Might also want to check ‘open source etiquettes’ on github. Like:
Just a few points that relate to this topic:
Never put pressure on an open-source project’s author if he is unavailable or too busy as that comes across as disrespectful and might discourage them from becoming available, especially given that they offer the project as a free service
Always provide examples (aka samples) of how to use your open-source project.
- Documentation is optional in an open-source project because software engineers can always read the source code directly and try out examples to understand how it works, assuming the project has well-factored code and contains examples (aka samples). However, putting the effort into providing documentation greatly increases the popularity of an open-source project, so when possible, do your best to document your open-source project.