Claude-skill-registry annotations

Name: annotations
Author: majiayu000

Workflow for adding type annotations to Plain packages. Use this when adding or improving type coverage.

install

source · Clone the upstream repo

git clone https://github.com/majiayu000/claude-skill-registry

Claude Code · Install into ~/.claude/skills/

T=$(mktemp -d) && git clone --depth=1 https://github.com/majiayu000/claude-skill-registry "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/data/annotations" ~/.claude/skills/majiayu000-claude-skill-registry-annotations && rm -rf "$T"

manifest: skills/data/annotations/SKILL.md

source content

Type Annotation Workflow

We are gradually adding type annotations using Python 3.13+.

Workflow

Check current coverage:

uv run plain code annotations <directory> --details

Add annotations: Focus on function/method signatures (parameters and return types)

Type check:

./scripts/type-check <directory>

Format:
```
./scripts/fix
```
Test:
```
./scripts/test <package>
```

Verify improvement:

uv run plain code annotations <directory>

Add to validation: Once a directory reaches 100% coverage, add it to
```
FULLY_TYPED_PATHS
```
in
```
scripts/type-validate
```

Guidelines

Add
```
from __future__ import annotations
```
when necessary
Focus on public APIs and user-facing methods first
Don't annotate
```
__init__
```
return types (type checkers infer
```
None
```
)
Use explicit
```
return None
```
for functions with
```
-> Type | None
```
return type
Some Django-style ORM patterns are inherently difficult to type - that's okay
Goal is progress, not perfection

Example

# Check coverage
uv run plain code annotations plain/plain/assets --details

# After adding annotations...
./scripts/type-check plain/plain/assets
./scripts/fix
./scripts/test plain
uv run plain code annotations plain/plain/assets  # Should show 100%