Ambiguity in "supporting issues"
The phrase "supporting issues" is vague. Does it mean general usage questions? Or troubleshooting help?
Consider rewording to:
For general troubleshooting and usage questions, please use Stack Overflow. The issue tracker is only for reporting bugs.
"Issue tracker is ONLY used for reporting bugs"
This is clear, but what if an issue is a bug report mixed with a feature request? Should users split them?
You could clarify:
If a feature request is related to a bug, report the bug here and discuss the feature request on Slack.
No Mention of Logs or Screenshots
A section for logs, error messages, or screenshots would help with debugging.
Consider adding a new section:
md
Copy
Edit
Logs & Screenshots
No Mention of Version Information
If applicable, include a section asking for OS, browser, package versions, etc.:
md
Copy
Edit
System Information
- OS:
- Browser:
- Package Version:
- Node.js Version (if applicable):
Ambiguity in "supporting issues"
The phrase "supporting issues" is vague. Does it mean general usage questions? Or troubleshooting help?
Consider rewording to:
For general troubleshooting and usage questions, please use Stack Overflow. The issue tracker is only for reporting bugs.
"Issue tracker is ONLY used for reporting bugs"
This is clear, but what if an issue is a bug report mixed with a feature request? Should users split them?
You could clarify:
If a feature request is related to a bug, report the bug here and discuss the feature request on Slack.
No Mention of Logs or Screenshots
A section for logs, error messages, or screenshots would help with debugging.
Consider adding a new section:
md
Copy
Edit
Logs & Screenshots
No Mention of Version Information
If applicable, include a section asking for OS, browser, package versions, etc.:
md
Copy
Edit
System Information