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

Merged
merged 5 commits into from
Jul 17, 2025
Merged

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

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
239ba05
docs: add pre-commit
dingo4dev Jun 20, 2025
683ce88
Update CONTRIBUTING.md
dingo4dev Jun 20, 2025
d4f3cfc
Update CONTRIBUTING.md
dingo4dev Jul 6, 2025
6467422
Merge branch 'main' into doc/pre-commit
dingo4dev Jul 6, 2025
aac419f
Fix code block indentation formatting in CONTRIBUTING.md
felixweinberger Jul 17, 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
14 changes: 13 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ Thank you for your interest in contributing to the MCP Python SDK! This document
uv sync --frozen --all-extras --dev
```

6. Set up pre-commit hooks:

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

## Development Workflow

1. Choose the correct branch for your changes:
Expand Down Expand Up @@ -45,7 +51,13 @@ uv run ruff format .
uv run scripts/update_readme_snippets.py
```

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

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

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

## Code Style

Expand Down
Loading