Skip to content

Commit 867ca9f

Browse files
committed
Add developer workflow section to README and update package.json for Rust commands
1 parent 58f5c0a commit 867ca9f

File tree

5 files changed

+379
-686
lines changed

5 files changed

+379
-686
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,53 @@ See [packages/desktop/README.md](packages/desktop/README.md) for configuration d
124124

125125
---
126126

127+
## Developer Workflow
128+
129+
Common development tasks using `pnpm`:
130+
131+
```bash
132+
# Development
133+
pnpm install # Install dependencies
134+
pnpm build # Build all packages
135+
pnpm dev # Start dev mode (UI + Core)
136+
pnpm dev:web # UI only
137+
pnpm dev:cli # CLI only
138+
pnpm dev:desktop # Desktop app
139+
140+
# Testing
141+
pnpm test # Run all tests
142+
pnpm test:ui # Tests with UI
143+
pnpm test:coverage # Coverage report
144+
pnpm typecheck # Type check all packages
145+
146+
# Rust
147+
pnpm rust:build # Build Rust packages (release)
148+
pnpm rust:build:dev # Build Rust (dev, faster)
149+
pnpm rust:test # Run Rust tests
150+
pnpm rust:check # Quick Rust check
151+
pnpm rust:clippy # Rust linting
152+
pnpm rust:fmt # Format Rust code
153+
154+
# CLI (run locally)
155+
pnpm cli board # Show spec board
156+
pnpm cli list # List specs
157+
pnpm cli create my-feat # Create new spec
158+
pnpm cli validate # Validate specs
159+
160+
# Documentation
161+
pnpm docs:dev # Start docs site
162+
pnpm docs:build # Build docs
163+
164+
# Release
165+
pnpm pre-release # Run all pre-release checks
166+
pnpm prepare-publish # Prepare for npm publish
167+
pnpm restore-packages # Restore after publish
168+
```
169+
170+
See [package.json](package.json) for all available scripts.
171+
172+
---
173+
127174
## Documentation
128175

129176
📖 [Full Documentation](https://www.lean-spec.dev) · [CLI Reference](https://www.lean-spec.dev/docs/reference/cli) · [First Principles](https://www.lean-spec.dev/docs/advanced/first-principles) · [FAQ](https://www.lean-spec.dev/docs/faq) · [中文文档](https://www.lean-spec.dev/zh-Hans/)

0 commit comments

Comments
 (0)