Skip to content

Add CLAUDE.md with project notes and workflows #1

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

Open
CorVous wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add CLAUDE.md with project notes and workflows #1

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
081a464
Add CLAUDE.md with project notes and workflows
CorVous Apr 8, 2026
c74b024
Update commands for code assignment process
CorVous Apr 8, 2026
c88ab95
Clarify stub requirement for valid red tests
CorVous Apr 8, 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
26 changes: 26 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Claude Notes

## First Step

Update uv before anything else: `uv self update`

## Key Documents

- **`plan.md`** — contains the project plan and feature roadmap
- **`README.md`** — contains project overview and development commands

## TDD Workflow

Always follow red/green TDD:
1. Write a failing test first (red)
2. Write the minimum code to make it pass (green)
3. Refactor if needed

**Import errors do not count as red.** A test that fails due to an `ImportError` or `ModuleNotFoundError` is not a valid red test — the module/function must exist as a stub before the test can legitimately fail for the right reason.

## After Every Code Assignment

1. Run `uv sync --dev` to keep dependencies up to date
2. Run `uv run ruff check` to lint
3. Run `uv run ruff format` to format
4. Run `uv run ty check` to type-check