Create CONTRIBUTING.md

This commit is contained in:
Justin Spahr-Summers 2024-11-25 09:07:56 -06:00
commit 6cd6831ac7
No known key found for this signature in database

43
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,43 @@
# 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](CODE_OF_CONDUCT.md). Please review it before contributing.
## Reporting Issues
- Use the [GitHub issue tracker](https://github.com/modelcontextprotocol/create-typescript-server/issues)
- Provide clear reproduction steps
- Include relevant system information
- Specify the version you're using
## Security Issues
Please review our [Security Policy](SECURITY.md) for reporting security vulnerabilities.
## License
By contributing, you agree that your contributions will be licensed under the MIT License.