Feedback & Support

We value your feedback and are committed to improving zzson based on user experiences. This page explains how to report issues, request features, and get support.

🔧 Web Tool Feedback

The zzson web tool includes a built-in feedback system that makes it easy to report issues and suggest improvements.

How to Use the Feedback System

  1. Click the feedback button - Look for the floating feedback button in the bottom-right corner of the web tool
  2. Choose feedback type - Select from:
    • 🐛 Bug Report - Something isn’t working correctly
    • ✨ Feature Request - Suggest new functionality
    • 🔧 Improvement Suggestion - Ideas for enhancements
    • 💬 General Feedback - Any other comments
    • ⚡ Performance Issue - Slow parsing or loading
    • 🎨 UI/UX Feedback - Interface improvements
  3. Fill out the form - Provide a clear subject and detailed description
  4. Include context - Optionally include browser/system information and current tool state
  5. Submit - The system will create a GitHub issue template for you

What Information is Collected

The feedback system respects your privacy and only collects:

  • Required: Feedback type, subject, and description
  • Optional: Email address (for follow-up)
  • Optional: Browser/system information (helps debug issues)
  • Optional: Current tool state (parser options, input sample)

Rate Limits

To prevent spam, the feedback system limits submissions to 5 per day per browser.

📋 GitHub Issues

For detailed bug reports and feature requests, use our GitHub Issues:

Bug Reports

Use the Bug Report Template and include:

  • Clear description of the bug
  • Steps to reproduce the issue
  • Expected behavior vs actual behavior
  • Input sample that causes the problem
  • Environment details (OS, browser, version)
  • Parser options that were enabled
  • Error messages if any

Feature Requests

Use the Feature Request Template and include:

  • Problem description - What need does this address?
  • Proposed solution - What would you like to see?
  • Use case - How would you use this feature?
  • Example input/output - Show what it would look like
  • Priority level - How important is this to you?

Performance Issues

Use the Performance Issue Template and include:

  • Performance problem description
  • Input characteristics (size, complexity)
  • Measurements (timing, memory usage)
  • Environment details (hardware, browser)
  • Comparison with other parsers if available

💬 Community Discussion

For questions, ideas, and general discussion, use GitHub Discussions:

  • Q&A - Ask questions about usage
  • Ideas - Share feature ideas and get feedback
  • Show and Tell - Share how you’re using zzson
  • General - Any other discussion

📧 Direct Contact

For security issues or private matters, you can contact the maintainer directly:

  • Email: adam+zzson@twardoch.com
  • Security: Please use responsible disclosure for security issues

🎯 What Makes Good Feedback

For Bug Reports

  • Reproducible steps - Can others follow your steps and see the issue?
  • Minimal example - The smallest input that demonstrates the problem
  • Clear expectations - What should happen vs what actually happens
  • Environment details - Help us understand your setup

For Feature Requests

  • Real use case - Why do you need this feature?
  • Clear specification - What exactly should it do?
  • Compatibility - How should it work with existing features?
  • Examples - Show input/output examples

For Performance Issues

  • Specific measurements - Actual timing and memory usage
  • Input characteristics - Size and complexity details
  • Environment details - Hardware and software specifications
  • Comparison baseline - How does it compare to expectations?

🔄 Feedback Process

  1. Submission - You submit feedback through any channel
  2. Triage - We review and categorize the feedback
  3. Discussion - We may ask follow-up questions
  4. Implementation - Valid issues/features are added to roadmap
  5. Testing - Changes are tested thoroughly
  6. Release - Improvements are released in new versions
  7. Follow-up - We’ll let you know when your feedback is addressed

🚀 Contributing

Want to contribute code? See our Contributing Guide for:

  • Development setup
  • Code style guidelines
  • Testing requirements
  • Pull request process

📊 Feedback Statistics

The feedback system tracks anonymous usage statistics to help us improve:

  • Number of feedback submissions by type
  • Most common issues and requests
  • Response times and resolution rates
  • User satisfaction trends

All statistics are aggregated and anonymized to protect privacy.

✅ Response Times

We aim to respond to feedback within:

  • Critical bugs: 24 hours
  • Bug reports: 3-5 days
  • Feature requests: 1-2 weeks
  • General questions: 3-5 days

Response times may vary based on complexity and maintainer availability.

Thank you for helping make zzson better! Your feedback drives improvements and helps us build a tool that works well for everyone.