File tree Expand file tree Collapse file tree 1 file changed +10
-3
lines changed Expand file tree Collapse file tree 1 file changed +10
-3
lines changed Original file line number Diff line number Diff line change @@ -7,13 +7,20 @@ First off, thank you for considering contributing to FastAPI-MCP!
7
7
1 . Make sure you have Python 3.10+ installed
8
8
2 . Install [ uv] ( https://docs.astral.sh/uv/getting-started/installation/ ) (recommended) or pip
9
9
3 . Fork the repository
10
- 4 . Clone your fork and set up the development environment:
10
+ 4 . Clone your fork
11
11
12
12
``` bash
13
13
# Clone your fork
14
14
git clone https://github.com/YOUR-USERNAME/fastapi_mcp.git
15
15
cd fastapi-mcp
16
16
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
17
24
# Create a virtual environment with uv (recommended)
18
25
uv venv
19
26
source .venv/bin/activate # On Windows: .venv\Scripts\activate
@@ -29,15 +36,15 @@ uv sync --extra dev
29
36
30
37
## Development Process
31
38
32
- 1 . Fork the repository
39
+ 1 . Fork the repository and set the upstream remote
33
40
2 . Create a feature branch (` git checkout -b feature/amazing-feature ` )
34
41
3 . Make your changes
35
42
4 . Run type checking (` uv run mypy . ` )
36
43
5 . Run the tests (` uv run pytest ` )
37
44
6 . Format your code (` uv run ruff check . ` and ` uv run ruff format . ` )
38
45
7 . Commit your changes (` git commit -m 'Add some amazing feature' ` )
39
46
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/ )
41
48
42
49
## Code Style
43
50
You can’t perform that action at this time.
0 commit comments