Skip to content
This repository was archived by the owner on Mar 24, 2025. It is now read-only.

Latest commit

 

History

History
43 lines (28 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

43 lines (28 loc) · 1.37 KB

Contributing

Thank you for your interest in contributing to create-typescript-server! This tool helps developers quickly scaffold new MCP (Model Context Protocol) servers.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/create-typescript-server.git
  3. Install dependencies: npm install
  4. Build the project: npm run build

Development

  • Make your changes in the src directory
  • Use npm run watch during development for automatic rebuilding
  • Test your changes by creating a new server: ./build/index.js test-server

Pull Requests

  1. Create a new branch for your changes
  2. Make your changes
  3. Ensure the build passes: npm run build
  4. Test server creation using your changes
  5. Submit a pull request with a clear description of your changes

Code of Conduct

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

Reporting Issues

  • Use the GitHub issue tracker
  • Provide clear reproduction steps
  • Include relevant system information
  • Specify the version you're using

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.