From c959a1371732f1f5a4cded6c6d22ca4cda0ce8f1 Mon Sep 17 00:00:00 2001 From: Justin Spahr-Summers Date: Wed, 27 Nov 2024 09:09:54 -0600 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cfe4a16 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,66 @@ +# Contributing to Model Context Protocol + +Thank you for your interest in contributing to the Model Context Protocol (MCP)! This document provides guidelines for contributing to any repository in the MCP organization. + +## How to Contribute + +### Issues and Discussions +- For bugs and actionable items, please prefer creating an issue in the relevant repository +- For open-ended or design discussions _specifically related to the specification_, use our [specification discussions](https://github.com/modelcontextprotocol/specification/discussions) +- For other general discussions that are not suitable as issues, use our [organization discussions](https://github.com/orgs/modelcontextprotocol/discussions) + +In all cases, please check for duplicates before creating new issues or discussions! + +### Pull Requests +We welcome PRs across all our repositories! When submitting: +- Fork the repository +- Follow existing code style +- Include tests where applicable +- Update documentation as needed +- Link related issues + +## Development Guidelines + +### Code Quality +- Follow the repository's established patterns +- Include appropriate documentation +- Add tests for new functionality +- Handle errors appropriately + +### Documentation +- Keep READMEs current +- Document configuration options +- Provide clear examples +- Include setup instructions + +### Security +- Follow security best practices +- Implement proper input validation +- Document security considerations + +## Getting Started + +1. Fork the repository +2. Clone your fork: + ```bash + git clone https://github.com/your-username/repository-name.git + ``` +3. Create a feature branch: + ```bash + git checkout -b my-feature + ``` +4. Make your changes and commit: + ```bash + git commit -m "Description of changes" + ``` +5. Push and create a Pull Request + +## Code of Conduct + +Please note that this project is released with a [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. + +## License + +By contributing, you agree that your contributions will be licensed under the MIT License. + +Thank you for contributing to Model Context Protocol!