Skip to content

Commit 30b5007

Browse files
author
shiraayal-tadata
committed
contributing modification
1 parent bda9dc6 commit 30b5007

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,20 @@ First off, thank you for considering contributing to FastAPI-MCP!
77
1. Make sure you have Python 3.10+ installed
88
2. Install [uv](https://docs.astral.sh/uv/getting-started/installation/) (recommended) or pip
99
3. Fork the repository
10-
4. Clone your fork and set up the development environment:
10+
4. Clone your fork
1111

1212
```bash
1313
# Clone your fork
1414
git clone https://github.com/YOUR-USERNAME/fastapi_mcp.git
1515
cd fastapi-mcp
1616

17+
# Add the upstream remote
18+
git remote add upstream https://github.com/tadata-org/fastapi_mcp.git
19+
```
20+
21+
5. Set up the development environment:
22+
23+
```bash
1724
# Create a virtual environment with uv (recommended)
1825
uv venv
1926
source .venv/bin/activate # On Windows: .venv\Scripts\activate
@@ -29,15 +36,15 @@ uv sync --extra dev
2936

3037
## Development Process
3138

32-
1. Fork the repository
39+
1. Fork the repository and set the upstream remote
3340
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3441
3. Make your changes
3542
4. Run type checking (`uv run mypy .`)
3643
5. Run the tests (`uv run pytest`)
3744
6. Format your code (`uv run ruff check .` and `uv run ruff format .`)
3845
7. Commit your changes (`git commit -m 'Add some amazing feature'`)
3946
8. Push to the branch (`git push origin feature/amazing-feature`)
40-
9. Open a Pull Request
47+
9. Open a Pull Request on [the project repository](https://github.com/tadata-org/fastapi_mcp/)
4148

4249
## Code Style
4350

0 commit comments

Comments
 (0)