Skip to content

docs: improve CLAUDE.md with additional development guidance #7763

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
jdx merged 1 commit into from
Jan 19, 2026
+6 −2
Merged

docs: improve CLAUDE.md with additional development guidance #7763

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co

### Building and Testing
- `mise run build` or `mise run b` - Build the project with cargo
- `target/debug/mise` - Run the built binary directly
- `mise run test` or `mise run t` - Run all tests (unit + e2e)
- `mise run test:unit` - Run unit tests only
- `mise run test:e2e` - Run end-to-end tests only
Expand All @@ -22,6 +23,8 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
- `mise run test:e2e [test_filename]...` - Run specific e2e tests (use this instead of executing test files directly)
- `mise --cd crates/vfox run test` - Run tests for the vfox crate
- `mise --cd crates/vfox run lint` - Run linting for the vfox crate
- `mise --cd crates/vfox run lint-fix` - Run linting and fix issues for the vfox crate
- `mise task ls` - List all available tasks

### Documentation and Generation
- `mise run render` - Generate all documentation and completions
Expand Down Expand Up @@ -79,7 +82,8 @@ Mise is a Rust CLI tool that manages development environments, tools, tasks, and

### Test Structure
- Unit tests within source files
- E2E tests in `e2e/` directory organized by feature area
- E2E tests in `e2e/` directory organized by feature area (e.g., `e2e/cli/`, `e2e/backend/`)
- E2E tests are bash scripts using assertion helpers from `e2e/assert.sh` (e.g., `assert`, `assert_contains`, `assert_fail`)
- Snapshot tests using `insta` crate for CLI output verification
- Windows-specific tests in `e2e-win/`

Expand All @@ -106,7 +110,7 @@ All commit messages and PR titles MUST follow conventional commit format:
- `test:` - Testing changes
- `chore:` - Maintenance tasks
- `chore(deps):` - Dependency updates
- `registry:` - New tool additions to the registry (no scope needed)
- `registry:` - New tool additions to `registry.toml` (no scope needed)

**Common Scopes:** `aqua`, `cli`, `config`, `backend`, `tool`, `env`, `task`, `api`, `ui`, `core`, `deps`, `schema`, `doctor`, `shim`, `security`

Expand Down
Loading