Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 1.42 KB

Contributing to MCP TypeScript SDK

We welcome contributions to the Model Context Protocol TypeScript SDK! This document outlines the process for contributing to the project.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR-USERNAME/typescript-sdk.git
  3. Install dependencies: npm install
  4. Build the project: npm run build
  5. Run tests: npm test

Development Process

  1. Create a new branch for your changes
  2. Make your changes
  3. Run npm run lint to ensure code style compliance
  4. Run npm test to verify all tests pass
  5. Submit a pull request

Pull Request Guidelines

  • Follow the existing code style
  • Include tests for new functionality
  • Update documentation as needed
  • Keep changes focused and atomic
  • Provide a clear description of changes

Running Examples

  • Start the server: npm run server
  • Run the client: npm run client

Code of Conduct

This project follows our Code of Conduct. Please review it before contributing.

Reporting Issues

  • Use the GitHub issue tracker
  • Search existing issues before creating a new one
  • Provide clear reproduction steps

Security Issues

Please review our Security Policy for reporting security vulnerabilities.

License

By contributing, you agree that your contributions will be licensed under the MIT License.