Skip to content
This repository was archived by the owner on Mar 24, 2025. It is now read-only.

Commit b07744d

Browse files
Merge pull request #4 from modelcontextprotocol/justin/contributing
Create CONTRIBUTING.md
2 parents 7d921b9 + 40083e7 commit b07744d

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

Diff for: CONTRIBUTING.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to `create-mcp-server`! This tool helps developers quickly scaffold new MCP (Model Context Protocol) servers.
4+
5+
## Getting Started
6+
7+
1. Fork the repository
8+
2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/create-python-server.git`
9+
3. Install dependencies: `uv sync --dev --all-extras`
10+
11+
## Development
12+
13+
- Make your changes in the `src` directory
14+
- Test your changes by creating a new server: `uv run -m create_mcp_server test-server`
15+
- Run type checking: `uv run pyright`
16+
- Run linting: `uv run ruff check .`
17+
18+
## Pull Requests
19+
20+
1. Create a new branch for your changes
21+
2. Make your changes
22+
3. Ensure type checking and linting pass
23+
4. Test server creation using your changes
24+
5. Submit a pull request with a clear description of your changes
25+
26+
## Code of Conduct
27+
28+
This project follows our [Code of Conduct](CODE_OF_CONDUCT.md). Please review it before contributing.
29+
30+
## Reporting Issues
31+
32+
- Use the [GitHub issue tracker](https://github.com/modelcontextprotocol/create-python-server/issues)
33+
- Provide clear reproduction steps
34+
- Include relevant system information
35+
- Specify the version you're using
36+
37+
## Security Issues
38+
39+
Please review our [Security Policy](SECURITY.md) for reporting security vulnerabilities.
40+
41+
## License
42+
43+
By contributing, you agree that your contributions will be licensed under the MIT License.

0 commit comments

Comments
 (0)