Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (40 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

57 lines (40 loc) · 1.19 KB

Contributing to mysql-mcp

Thank you for your interest in contributing to mysql-mcp! This document provides guidelines for contributing.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a branch for your changes (git checkout -b feature/amazing-feature)
  4. Make your changes
  5. Test your changes thoroughly
  6. Commit with clear, descriptive messages
  7. Push to your fork
  8. Open a Pull Request

Development Setup

# Clone your fork
git clone https://github.com/YOUR_USERNAME/mysql-mcp.git
cd mysql-mcp

# Install dependencies
npm install

# Run tests
npm test

# Build
npm run build

Guidelines

Code Style

  • Follow the existing code style
  • Use TypeScript for all new code
  • Add comments for complex logic
  • Keep functions focused and small

Commits

  • Use clear, descriptive commit messages
  • Reference issues when applicable (Fixes #123)
  • Keep commits atomic (one logical change per commit)

Pull Requests

  • Provide a clear description of changes
  • Reference any related issues
  • Ensure all tests pass
  • Update documentation if needed

Questions?

If you have questions, feel free to open an issue for discussion.