-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Add CONTRIBUTING.md #64
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # 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](CODE_OF_CONDUCT.md). Please review it before contributing. | ||
|
|
||
| ## Reporting Issues | ||
|
|
||
| - Use the [GitHub issue tracker](https://github.com/modelcontextprotocol/typescript-sdk/issues) | ||
| - Search existing issues before creating a new one | ||
| - Provide clear reproduction steps | ||
|
|
||
| ## 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is inconsistent with the approach in https://github.com/modelcontextprotocol/python-sdk/blob/main/CONTRIBUTING.md. We either tell people to fork and then clone or to clone the main repo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, I'll fix the Python one. Forking will be necessary for most folks.