Skip to content

docs: add pre-commit install guide on CONTRIBUTING.md #995

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+12 −1
Open

docs: add pre-commit install guide on CONTRIBUTING.md #995

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f02e7ca
docs: add pre-commit
dingo4dev Jun 20, 2025
aafe1ab
Update CONTRIBUTING.md
dingo4dev Jun 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ Thank you for your interest in contributing to the MCP Python SDK! This document
```bash
uv sync --frozen --all-extras --dev
```
6. Set up pre-commit hooks:

```bash
uv tool install pre-commit --with pre-commit-uv --force-install
```

## Development Workflow

Expand Down Expand Up @@ -40,7 +45,13 @@ uv run ruff check .
uv run ruff format .
```

7. Submit a pull request to the same branch you branched from
7. (Optional) Run pre-commit hooks on all files:

```bash
pre-commit run --all-files
```

8. Submit a pull request to the same branch you branched from

## Code Style

Expand Down
Loading