Skip to content

Commit 35f8a89

Browse files
authored
docs: add CONTRIBUTING.md (#275)
1 parent e5121b3 commit 35f8a89

File tree

2 files changed

+42
-54
lines changed

2 files changed

+42
-54
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to the MCP Go SDK! We welcome contributions of all kinds, including bug fixes, new features, and documentation improvements. This document outlines the process for contributing to the project.
4+
5+
## Development Guidelines
6+
7+
### Prerequisites
8+
9+
Make sure you have Go 1.23 or later installed on your machine. You can check your Go version by running:
10+
11+
```bash
12+
go version
13+
```
14+
15+
### Setup
16+
17+
1. Fork the repository
18+
2. Clone your fork:
19+
20+
```bash
21+
git clone https://github.com/YOUR_USERNAME/mcp-go.git
22+
cd mcp-go
23+
```
24+
3. Install the required packages:
25+
26+
```bash
27+
go mod tidy
28+
```
29+
30+
### Workflow
31+
32+
1. Create a new branch.
33+
2. Make your changes.
34+
3. Ensure you have added tests for any new functionality.
35+
4. Run the tests as shown below from the root directory:
36+
37+
```bash
38+
go test -v './...'
39+
```
40+
5. Submit a pull request to the main branch.
41+
42+
Feel free to reach out if you have any questions or need help either by [opening an issue](https://github.com/mark3labs/mcp-go/issues) or by reaching out in the [Discord channel](https://discord.gg/RqSS2NQVsY).

README.md

Lines changed: 0 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -746,57 +746,3 @@ Add middleware to tool call handlers using the `server.WithToolHandlerMiddleware
746746

747747
A recovery middleware option is available to recover from panics in a tool call and can be added to the server with the `server.WithRecovery` option.
748748

749-
## Contributing
750-
751-
<details>
752-
753-
<summary><h3>Open Developer Guide</h3></summary>
754-
755-
### Prerequisites
756-
757-
Go version >= 1.23
758-
759-
### Installation
760-
761-
Create a fork of this repository, then clone it:
762-
763-
```bash
764-
git clone https://github.com/mark3labs/mcp-go.git
765-
cd mcp-go
766-
```
767-
768-
### Testing
769-
770-
Please make sure to test any new functionality. Your tests should be simple and atomic and anticipate change rather than cement complex patterns.
771-
772-
Run tests from the root directory:
773-
774-
```bash
775-
go test -v './...'
776-
```
777-
778-
### Opening a Pull Request
779-
780-
Fork the repository and create a new branch:
781-
782-
```bash
783-
git checkout -b my-branch
784-
```
785-
786-
Make your changes and commit them:
787-
788-
789-
```bash
790-
git add . && git commit -m "My changes"
791-
```
792-
793-
Push your changes to your fork:
794-
795-
796-
```bash
797-
git push origin my-branch
798-
```
799-
800-
Feel free to reach out in a GitHub issue or discussion if you have any questions!
801-
802-
</details>

0 commit comments

Comments
 (0)