Skip to content

Contributing

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

Contributing

Thank you for your interest in contributing to the Generic SQL API Framework!

Whether you're fixing bugs, improving documentation, suggesting new features, or submitting code, your contributions are greatly appreciated.

Ways to Contribute

You can contribute in many ways, including:

  • Reporting bugs
  • Suggesting new features
  • Improving documentation
  • Fixing issues
  • Optimizing performance
  • Writing tests
  • Improving examples
  • Reviewing pull requests

Development Setup

1. Fork the Repository

Click the Fork button on GitHub.

2. Clone Your Fork

git clone https://github.com/YOUR_USERNAME/Generic_SQL_API_Framework.git

3. Create a Branch

git checkout -b feature/my-new-feature

Use descriptive branch names.

Examples:

feature/query-cache
feature/mysql-support
bugfix/json-validation
docs/wiki-update

4. Make Your Changes

Keep changes focused on a single feature or fix.

Examples:

  • Improve validation
  • Fix SQL execution
  • Update documentation
  • Add new examples

5. Test Your Changes

Before submitting a pull request:

  • Verify the application runs correctly.
  • Test affected APIs.
  • Validate SQL queries.
  • Ensure documentation is updated if necessary.

6. Commit Your Changes

Use clear commit messages.

Examples:

git commit -m "feat: add support for aggregate functions"
git commit -m "fix: resolve parameter validation issue"
git commit -m "docs: update installation guide"

7. Push Your Branch

git push origin feature/my-new-feature

8. Open a Pull Request

Create a Pull Request describing:

  • What changed
  • Why it changed
  • Any breaking changes
  • Related issue number (if applicable)

Coding Guidelines

Please follow these principles:

  • Keep code simple and readable.
  • Write modular code.
  • Use meaningful variable and function names.
  • Avoid unnecessary complexity.
  • Add comments only where they improve understanding.
  • Follow the existing project structure.

Documentation Guidelines

Documentation is just as important as code.

If your contribution changes behavior, please update:

  • README
  • Wiki
  • Examples
  • API documentation

Reporting Bugs

Before opening an issue:

  • Search existing issues.
  • Confirm the issue still exists.
  • Collect logs and error messages.
  • Include steps to reproduce.

A good bug report includes:

  • Framework version
  • PHP version
  • SQL Server version
  • Operating system
  • Expected behavior
  • Actual behavior

Feature Requests

Feature requests should include:

  • Problem statement
  • Proposed solution
  • Use case
  • Additional context (if any)

Code Review

All pull requests are reviewed before merging.

Reviewers may request:

  • Code improvements
  • Documentation updates
  • Additional testing
  • Performance improvements

Please be patient and responsive to feedback.

Code of Conduct

Be respectful and constructive.

We aim to build a welcoming community where everyone can contribute regardless of experience level.

Thank You

Every contribution—whether it's code, documentation, bug reports, or ideas—helps improve the Generic SQL API Framework.

Thank you for supporting the project!

Clone this wiki locally