Merge pull request #32 from jlowin/add-basic-contrib-guide

README.md

@@ -69,6 +69,7 @@ FastMCP handles all the complex protocol details and server management, so you c
 - [Examples](#examples)
   - [Echo Server](#echo-server)
   - [SQLite Explorer](#sqlite-explorer)
+- [Contributing](#contributing)
 
 ## Installation
 
@@ -83,6 +84,8 @@ Or with pip:
 pip install fastmcp
 ```
 
+See the [Contributing](#contributing) section for information on how to contribute to FastMCP.
+
 ## Quickstart
 
 Let's create a simple MCP server that exposes a calculator tool and some data:
@@ -425,3 +428,73 @@ Schema:
 
 What insights can you provide about the structure and relationships?"""
 ```
+
+## Contributing
+
+<details>
+
+<summary>Development Guide</summary>
+
+### Development Guide
+
+#### Prerequisites
+
+FastMCP requires Python 3.10+.
+
+#### Installation
+
+Clone a fork of the repository and install the dependencies:
+
+
+git clone https://github.com/youFancyUserYou/fastmcp.git
+cd fastmcp
+Activate a virtual environment:
+
+
+```bash
+uv venv
+source .venv/bin/activate
+uv sync --frozen --all-extras --dev
+```
+
+#### Install the pre-commit hooks:
+
+```bash
+pre-commit install
+```
+
+#### Testing
+
+Run the tests:
+
+
+```bash
+pytest -vv
+```
+
+
+#### Opening a Pull Request
+
+Fork the repository and create a new branch:
+
+```bash
+git checkout -b my-branch
+```
+
+Make your changes and commit them:
+
+
+```bash
+git add . && git commit -m "My changes"
+```
+
+Push your changes to your fork:
+
+
+```bash
+git push origin my-branch
+```
+
+Feel free to reach out in a GitHub Issue or Discussions if you have any questions!
+
+</details>