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

Fork the repository
Clone your fork: git clone https://github.com/YOUR_USERNAME/create-typescript-server.git
Install dependencies: npm install
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

Create a new branch for your changes
Make your changes
Ensure the build passes: npm run build
Test server creation using your changes
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.

1.4 KiB Raw Blame History