Skip to content

Commit 3cac129

Browse files
committed
Create CONTRIBUTING.md
1 parent 044378e commit 3cac129

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

CONTRIBUTING.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributing to MCP Documentation
2+
3+
Thank you for your interest in contributing to the Model Context Protocol (MCP) documentation! This guide will help you get started with contributing.
4+
5+
## Getting Started
6+
7+
1. Install the required tools:
8+
- Node.js
9+
- Git
10+
- [Mintlify CLI](https://www.npmjs.com/package/mintlify): `npm i -g mintlify`
11+
12+
2. Fork and clone the repository
13+
3. Create a new branch for your changes
14+
4. Run `mintlify dev` to preview changes locally
15+
16+
## Documentation Guidelines
17+
18+
- Keep content clear, concise, and technically accurate
19+
- Follow the existing file structure and naming conventions
20+
- Include code examples where appropriate
21+
- Use proper MDX formatting and components
22+
- Test all links and code samples
23+
24+
## Content Types
25+
26+
You can contribute to:
27+
28+
- Conceptual guides
29+
- API reference documentation
30+
- Tutorials and quickstarts
31+
- Best practices and examples
32+
- Troubleshooting guides
33+
34+
## Pull Request Process
35+
36+
1. Ensure your changes follow our documentation guidelines
37+
2. Update the relevant table of contents if needed
38+
3. Test your changes locally using `mintlify dev`
39+
4. Submit a pull request with a clear description of your changes
40+
5. Wait for review and address any feedback
41+
42+
## Need Help?
43+
44+
- Check existing documentation at [modelcontextprotocol.io](https://modelcontextprotocol.io)
45+
- [Open an issue](https://github.com/modelcontextprotocol/docs/issues) for bugs or concerns
46+
- Join our [community discussions](https://github.com/modelcontextprotocol/docs/discussions)
47+
48+
## Code of Conduct
49+
50+
Please note that this project follows our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold these guidelines.

0 commit comments

Comments
 (0)