Skip to content

Latest commit

 

History

History
94 lines (58 loc) · 2.52 KB

support.md

File metadata and controls

94 lines (58 loc) · 2.52 KB

Support

Thank you for using this project! Here's how to get help when you need it.

Quick Links

Before asking for help, check these resources first:

  • README - Installation, quick start, and basic usage
  • Documentation - Comprehensive guides and examples
  • FAQ - Common questions and answers

How to Get Support

GitHub Discussions

For general questions, ideas, and community help, use GitHub Discussions:

  • 💬 Q&A - Ask "How do I...?" questions
  • 💡 Ideas - Suggest new features or improvements
  • 🙌 Show and Tell - Share what you've built

This is the right place for troubleshooting, implementation advice, and design discussions.

GitHub Issues

GitHub Issues are for bug reports and feature requests only.

✅ Use Issues for:

  • Confirmed bugs in the code
  • Specific feature requests with clear use cases
  • Security vulnerabilities (see security.md)

❌ Don't use Issues for:

  • General "How do I...?" questions (use Discussions)
  • Troubleshooting your specific setup (use Discussions)
  • Questions that could be answered by documentation

Community Channels

Connect with other users:

Asking Good Questions

Help us help you by including:

Context

  • What you're trying to accomplish
  • What you expected to happen
  • What actually happened

Environment Details

  • Project version (check with --version)
  • Operating system and version
  • Node.js/Python/relevant runtime version if applicable

Code & Logs

  • Minimal reproducible example
  • Complete error messages (text format, not screenshots)
  • Steps to reproduce the issue

What You've Tried

  • Search results you've checked
  • Documentation you've reviewed
  • Troubleshooting steps you've attempted

Response Times

This project is maintained by volunteers. We'll do our best to respond promptly:

  • Critical security issues: 48 hours (see security.md)
  • Bug reports: As soon as possible
  • Feature requests: As time permits
  • Questions in Discussions: Community-driven, no guaranteed response

Contributing

Found a solution to your problem? Help others:

  • Answer questions in Discussions
  • Improve the documentation (submit a PR)
  • Fix the bug you discovered (see contributing.md

Code of Conduct

All support interactions are governed by our Code of Conduct Be respectful, patient, and constructive.