Skip to content

chore: add more opinions to CLAUDE.md #1887

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
maxisbey merged 2 commits into from
Jan 16, 2026
+6 −12
Merged

chore: add more opinions to CLAUDE.md #1887

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2466010
chore: add more opinions to CLAUDE.md
Kludex Jan 16, 2026
81c5065
Merge branch 'main' into improve-claude-md
Kludex Jan 16, 2026
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
18 changes: 6 additions & 12 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ This document contains critical information about working with this codebase. Fo

1. Package Management
- ONLY use uv, NEVER pip
- Installation: `uv add package`
- Running tools: `uv run tool`
- Upgrading: `uv add --dev package --upgrade-package package`
- Installation: `uv add <package>`
- Running tools: `uv run <tool>`
- Upgrading: `uv lock --upgrade-package <package>`
- FORBIDDEN: `uv pip install`, `@latest` syntax

2. Code Quality
Expand All @@ -21,6 +21,7 @@ This document contains critical information about working with this codebase. Fo
3. Testing Requirements
- Framework: `uv run --frozen pytest`
- Async testing: use anyio, not asyncio
- Do not use `Test` prefixed classes, use functions
- Coverage: test edge cases and errors
- New features require tests
- Bug fixes require regression tests
Expand Down Expand Up @@ -77,12 +78,11 @@ rather than adding new standalone sections.
- Line wrapping:
- Strings: use parentheses
- Function calls: multi-line with proper indent
- Imports: split into multiple lines
- Imports: try to use a single line

2. Type Checking
- Tool: `uv run --frozen pyright`
- Requirements:
- Explicit None checks for Optional
- Type narrowing for strings
- Version warnings can be ignored if checks pass

Expand Down Expand Up @@ -117,10 +117,6 @@ rather than adding new standalone sections.
- Add None checks
- Narrow string types
- Match existing patterns
- Pytest:
- If the tests aren't finding the anyio pytest mark, try adding PYTEST_DISABLE_PLUGIN_AUTOLOAD=""
to the start of the pytest run command eg:
`PYTEST_DISABLE_PLUGIN_AUTOLOAD="" uv run --frozen pytest`

3. Best Practices
- Check git status before commits
Expand All @@ -138,6 +134,4 @@ rather than adding new standalone sections.
- File ops: `except (OSError, PermissionError):`
- JSON: `except json.JSONDecodeError:`
- Network: `except (ConnectionError, TimeoutError):`
- **Only catch `Exception` for**:
- Top-level handlers that must not crash
- Cleanup blocks (log at debug level)
- **FORBIDDEN** `except Exception:` - unless in top-level handlers