From 2d5c866f82cddc5df8fce159e45a84b87d68cf0d Mon Sep 17 00:00:00 2001 From: Justin Spahr-Summers Date: Wed, 20 Nov 2024 15:26:05 +0000 Subject: [PATCH 1/3] Add CONTRIBUTING.md --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7901f1a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Contributing to Model Context Protocol Inspector + +Thanks for your interest in contributing! This guide explains how to get involved. + +## Getting Started + +1. Fork the repository and clone it locally +2. Install dependencies with `npm install` +3. Run `npm run build` to verify everything builds correctly + +## Development Process + +1. Create a new branch for your changes +2. Make your changes +3. Submit a pull request + +## Pull Request Process + +1. Update documentation as needed +2. Follow existing code style and conventions +3. Include useful commit messages explaining the changes +4. PRs will be reviewed by maintainers + +## Code of Conduct + +This project follows our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it before contributing. + +## Security + +If you find a security vulnerability, please refer to our [Security Policy](SECURITY.md) for reporting instructions. + +## Questions? + +Feel free to [open an issue](https://github.com/justinmahar/mcp-inspector/issues) for questions or create a discussion for general topics. + +## License + +By contributing, you agree that your contributions will be licensed under the MIT license. From 1341d73775f66b0fceaa526bba27486716aea1bb Mon Sep 17 00:00:00 2001 From: Justin Spahr-Summers Date: Wed, 20 Nov 2024 16:00:03 +0000 Subject: [PATCH 2/3] Fix issues link --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7901f1a..a2a57cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,7 @@ If you find a security vulnerability, please refer to our [Security Policy](SECU ## Questions? -Feel free to [open an issue](https://github.com/justinmahar/mcp-inspector/issues) for questions or create a discussion for general topics. +Feel free to [open an issue](https://github.com/modelcontextprotocol/mcp-inspector/issues) for questions or create a discussion for general topics. ## License From 60dea9a86886eed8f521e5f074e6268ad34b7a71 Mon Sep 17 00:00:00 2001 From: Justin Spahr-Summers Date: Wed, 20 Nov 2024 16:02:21 +0000 Subject: [PATCH 3/3] Clarify testing and submission steps --- CONTRIBUTING.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a2a57cb..9ad5699 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,20 +6,19 @@ Thanks for your interest in contributing! This guide explains how to get involve 1. Fork the repository and clone it locally 2. Install dependencies with `npm install` -3. Run `npm run build` to verify everything builds correctly +3. Run `npm run dev` to start both client and server in development mode +4. Use the web UI at http://localhost:5173 to interact with the inspector -## Development Process +## Development Process & Pull Requests 1. Create a new branch for your changes -2. Make your changes -3. Submit a pull request - -## Pull Request Process - -1. Update documentation as needed -2. Follow existing code style and conventions -3. Include useful commit messages explaining the changes -4. PRs will be reviewed by maintainers +2. Make your changes following existing code style and conventions +3. Test changes locally +4. Update documentation as needed +5. Use clear commit messages explaining your changes +6. Verify all changes work as expected +7. Submit a pull request +8. PRs will be reviewed by maintainers ## Code of Conduct