Skip to content

SUPPORT.md

Jump to bottom
Shashank Patil edited this page Jul 26, 2026 · 1 revision

Support

Thank you for using the Generic SQL API Framework!

This document explains how to get help, report issues, and request new features.

Documentation

Before requesting support, please review the available documentation:

  • README
  • Wiki
  • Installation Guide
  • Quick Start Guide
  • Troubleshooting
  • Frequently Asked Questions (FAQ)

Many common questions are already answered in these resources.

Reporting Bugs

If you believe you've found a bug:

  1. Search the existing GitHub Issues to see if it has already been reported.
  2. If not, create a new Bug Report.
  3. Include as much detail as possible.

A good bug report includes:

  • Framework version
  • PHP version
  • SQL Server version
  • Operating system
  • Web server (Apache, IIS, Nginx, etc.)
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Error messages or logs (if available)

Providing complete information helps reproduce and resolve issues faster.

Requesting Features

We welcome suggestions for improving the framework.

When submitting a feature request, include:

  • A clear description of the feature
  • The problem it solves
  • Your expected behavior
  • Any alternative solutions you've considered
  • Additional context or examples

Constructive feedback helps guide future development.

Questions and Discussions

If you have a question about using the framework:

  • Review the documentation first.
  • Check the FAQ.
  • Search existing GitHub Issues.
  • Open a new Discussion or Issue if your question has not already been answered.

Contributing

Interested in contributing?

You can help by:

  • Fixing bugs
  • Improving documentation
  • Writing tests
  • Suggesting new features
  • Submitting pull requests

Please read the CONTRIBUTING.md guide before contributing.

Security Issues

If you discover a security vulnerability, please do not report it publicly through GitHub Issues.

Instead, follow the process described in the SECURITY.md file.

Responsible disclosure helps protect all users of the framework.

Project Roadmap

To see what's planned for future releases, visit the ROADMAP.md document.

The roadmap includes:

  • Upcoming features
  • Planned improvements
  • Long-term goals

Stay Updated

Watch the GitHub repository to receive notifications about:

  • New releases
  • Bug fixes
  • Security updates
  • Documentation improvements
  • Feature announcements

Thank You

Your feedback, bug reports, feature requests, and contributions help make the Generic SQL API Framework better for everyone.

Thank you for being part of the project!

Clone this wiki locally