# Contributing to Multi-Database SQL MCP Server
Thank you for your interest in contributing! We welcome all types of contributions — bug reports, feature requests, documentation updates, and code improvements.
---
## Getting Started
1. Fork this repository to your GitHub account.
2. Clone your fork locally:
`git clone https://github.com/Soumya7681/sql-mcp-server.git`
3. Install dependencies:
`npm install`
4. Create a new branch for your contribution:
`git checkout -b feature/my-awesome-feature`
---
## Development Workflow
* Build the project:
`npm run build`
* Run MCP server directly from TypeScript (development mode):
`npm run start:mcp`
* Run linter and formatter:
`npm run lint`
`npm run format`
---
## Code Style Guidelines
* Use TypeScript for all source files.
* Follow existing naming conventions and project structure.
* Run ESLint and Prettier before committing:
`npm run lint`
`npm run format`
---
## Testing
* Add or update tests for any new features or fixes.
* Run all tests before submitting:
`npm test`
If tests or examples are missing, please open an issue before submitting a pull request.
---
## Commit Message Format
Follow the Conventional Commits format:
`<type>(scope): short description`
Examples:
* feat(mysql): add SSL configuration support
* fix(postgresql): resolve connection timeout issue
* docs: update MCP integration section
Common commit types:
* feat → new feature
* fix → bug fix
* docs → documentation changes
* style → code style or formatting
* refactor → code restructuring
* test → adding or fixing tests
* chore → maintenance or tooling updates
---
## Pull Request Process
1. Make sure your code builds without errors (`npm run build`).
2. Ensure all lint checks and tests pass.
3. Write a clear, descriptive PR title and body.
4. Reference related issues using GitHub keywords (e.g., Fixes #12).
5. Request a review from a maintainer.
---
## Reporting Issues
If you find a bug or have a feature idea:
* Check the existing issue tracker to avoid duplicates.
* Create a detailed issue describing:
* What happened
* Steps to reproduce
* Expected behavior
* Any relevant logs or screenshots
---
## Code of Conduct
Please note that this project follows a Code of Conduct (see `CODE_OF_CONDUCT.md`).
By participating, you agree to maintain a welcoming and respectful environment.
---
## Thank You
Your time and contributions make the **Multi-Database SQL MCP Server** better for everyone.
We’re grateful for every issue, pull request, and suggestion!
