aljaz/mcp-python-sdk
1
0
Fork 0
mirror of https://github.com/aljazceru/mcp-python-sdk.git synced 2025-12-19 14:54:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update CLAUDE.md with ruff and pre-commit info

Browse Source
This commit is contained in:
David Soria Parra
2025-01-03 15:57:56 +00:00
parent e21e8c157d
commit e32bf07433
1 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
CLAUDE.md
View File

@@ -29,10 +29,15 @@ This file is intended to be used by an LLM such as Claude.
- Handles both formatting and linting - Handles both formatting and linting
- For formatting: `uv run ruff format .` - For formatting: `uv run ruff format .`
- For checking: `uv run ruff check .` - For checking: `uv run ruff check .`
- For auto-fixing: `uv run ruff check . --fix`
- Common issues: - Common issues:
- Line length (default 88 chars) - Line length (default 88 chars)
- Import sorting - Import sorting (I001 errors)
- Unused imports - Unused imports
- When line length errors occur:
- For strings, use parentheses and line continuation
- For function calls, use multiple lines with proper indentation
- For imports, split into multiple lines
### Pyright ### Pyright
- Type checker - Type checker
@@ -42,6 +47,18 @@ This file is intended to be used by an LLM such as Claude.
- Optional types need explicit None checks - Optional types need explicit None checks
- String operations need type narrowing - String operations need type narrowing
## Pre-commit Hooks
- Configuration in `.pre-commit-config.yaml`
- Runs automatically on git commit
- Includes:
- Prettier for YAML/JSON formatting
- Ruff for Python formatting and linting
- When updating ruff version:
- Check available versions on PyPI
- Update `rev` in config to match available version
- Add and commit config changes before other changes
## Best Practices ## Best Practices
1. Always check git status and diff before committing 1. Always check git status and diff before committing