Skip to content

Commit d270f1f

Browse files
authored
Merge pull request #107 from serv-c/claude/issue-106-20250731-1235
docs: add mypy permissions setup
2 parents ba89e52 + 6888e6a commit d270f1f

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CLAUDE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Claude Development Instructions
2+
3+
## Type Checking with mypy
4+
5+
### Setup
6+
This project uses mypy for static type checking. The mypy dependency is included in `requirements-dev.txt`.
7+
8+
### Required Commands
9+
To enable full type checking capabilities, Claude needs permission to run:
10+
- `mypy servc --check-untyped-defs` - Run type checking on the servc package with untyped function checking
11+
- `pip install -r requirements-dev.txt` - Install development dependencies including mypy
12+
- `python -m pip install -r requirements-dev.txt` - Alternative pip installation method
13+
14+
### mypy Configuration
15+
The project includes type stubs and typing information:
16+
- `servc/py.typed` - Marks the package as type-aware
17+
- Type stubs for dependencies are included in requirements-dev.txt
18+
19+
### Development Workflow
20+
1. Install development dependencies: `pip install -r requirements-dev.txt`
21+
2. Run type checking: `mypy servc --check-untyped-defs`
22+
3. Fix any type issues before committing
23+
24+
## Permissions
25+
Claude requires the following Bash tool permissions:
26+
- `pip` commands for dependency installation
27+
- `python` commands for running type checkers
28+
- `mypy` commands for static type analysis

0 commit comments

Comments
 (0)